Admin SDK API . groups . aliases

Instance Methods

close()

Close httplib2 connections.

delete(groupKey, alias, x__xgafv=None)

Removes an alias.

insert(groupKey, body=None, x__xgafv=None)

Adds an alias for the group.

list(groupKey, x__xgafv=None)

Lists all aliases for a group.

Method Details

close()
Close httplib2 connections.
delete(groupKey, alias, x__xgafv=None)
Removes an alias.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
  alias: string, The alias to be removed (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
insert(groupKey, body=None, x__xgafv=None)
Adds an alias for the group.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # JSON template for Alias object in Directory API.
  "alias": "A String",
  "etag": "A String",
  "id": "A String",
  "kind": "admin#directory#alias",
  "primaryEmail": "A String",
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # JSON template for Alias object in Directory API.
  "alias": "A String",
  "etag": "A String",
  "id": "A String",
  "kind": "admin#directory#alias",
  "primaryEmail": "A String",
}
list(groupKey, x__xgafv=None)
Lists all aliases for a group.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # JSON response template to list aliases in Directory API.
  "aliases": [
    "",
  ],
  "etag": "A String",
  "kind": "admin#directory#aliases",
}