Admin SDK API . members

Instance Methods

close()

Close httplib2 connections.

delete(groupKey, memberKey, x__xgafv=None)

Removes a member from a group.

get(groupKey, memberKey, x__xgafv=None)

Retrieves a group member's properties.

hasMember(groupKey, memberKey, x__xgafv=None)

Checks whether the given user is a member of the group. Membership can be direct or nested.

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

Adds a user to the specified group.

list(groupKey, includeDerivedMembership=None, maxResults=None, pageToken=None, roles=None, x__xgafv=None)

Retrieves a paginated list of all members in a group.

list_next()

Retrieves the next page of results.

patch(groupKey, memberKey, body=None, x__xgafv=None)

Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).

update(groupKey, memberKey, body=None, x__xgafv=None)

Updates the membership of a user in the specified group.

Method Details

close()
Close httplib2 connections.
delete(groupKey, memberKey, x__xgafv=None)
Removes a member from 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)
  memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(groupKey, memberKey, x__xgafv=None)
Retrieves a group member's properties.

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)
  memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
  "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get.
  "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.
  "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).
  "status": "A String", # Status of member (Immutable)
  "type": "A String", # The type of group member.
}
hasMember(groupKey, memberKey, x__xgafv=None)
Checks whether the given user is a member of the group. Membership can be direct or nested.

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)
  memberKey: string, Identifies the user member in the API request. The value can be the user's primary email address, alias, or unique 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 template for Has Member response in Directory API.
  "isMember": True or False, # Output only. Identifies whether the given user is a member of the group. Membership can be direct or nested.
}
insert(groupKey, body=None, x__xgafv=None)
Adds a user to the specified 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:

{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
  "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get.
  "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.
  "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).
  "status": "A String", # Status of member (Immutable)
  "type": "A String", # The type of group member.
}

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

Returns:
  An object of the form:

    { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
  "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get.
  "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.
  "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).
  "status": "A String", # Status of member (Immutable)
  "type": "A String", # The type of group member.
}
list(groupKey, includeDerivedMembership=None, maxResults=None, pageToken=None, roles=None, x__xgafv=None)
Retrieves a paginated list of all members in 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)
  includeDerivedMembership: boolean, Whether to list indirect memberships. Default: false.
  maxResults: integer, Maximum number of results to return. Max allowed value is 200.
  pageToken: string, Token to specify next page in the list.
  roles: string, The `roles` query parameter allows you to retrieve group members by role. Allowed values are `OWNER`, `MANAGER`, and `MEMBER`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "etag": "A String", # ETag of the resource.
  "kind": "admin#directory#members", # Kind of resource this is.
  "members": [ # List of member objects.
    { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
      "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get.
      "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
      "etag": "A String", # ETag of the resource.
      "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.
      "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`.
      "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).
      "status": "A String", # Status of member (Immutable)
      "type": "A String", # The type of group member.
    },
  ],
  "nextPageToken": "A String", # Token used to access next page of this result.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
patch(groupKey, memberKey, body=None, x__xgafv=None)
Updates the membership properties of a user in the specified group. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).

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)
  memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
  "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get.
  "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.
  "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).
  "status": "A String", # Status of member (Immutable)
  "type": "A String", # The type of group member.
}

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

Returns:
  An object of the form:

    { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
  "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get.
  "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.
  "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).
  "status": "A String", # Status of member (Immutable)
  "type": "A String", # The type of group member.
}
update(groupKey, memberKey, body=None, x__xgafv=None)
Updates the membership of a user in the specified 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)
  memberKey: string, Identifies the group member in the API request. A group member can be a user or another group. The value can be the member's (group or user) primary email address, alias, or unique ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
  "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get.
  "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.
  "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).
  "status": "A String", # Status of member (Immutable)
  "type": "A String", # The type of group member.
}

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

Returns:
  An object of the form:

    { # A Google Groups member can be a user or another group. This member can be inside or outside of your account's domains. For more information about common group member tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-group-members).
  "delivery_settings": "A String", # Defines mail delivery preferences of member. This is only supported by create/update/get.
  "email": "A String", # The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.
  "kind": "admin#directory#member", # The type of the API resource. For Members resources, the value is `admin#directory#member`.
  "role": "A String", # The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).
  "status": "A String", # Status of member (Immutable)
  "type": "A String", # The type of group member.
}