Admin SDK . members

Instance Methods

close()

Close httplib2 connections.

delete(groupKey, memberKey, x__xgafv=None)

Remove membership.

get(groupKey, memberKey, x__xgafv=None)

Retrieve 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.

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

Add user to the specified group.

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

Retrieve all members in a group (paginated)

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

Patch Member via Apiary Patch Orchestration

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

Update membership of a user in the specified group.

Method Details

close()
Close httplib2 connections.
delete(groupKey, memberKey, x__xgafv=None)
Remove membership.

Args:
  groupKey: string, Email or immutable ID of the group (required)
  memberKey: string, Email or immutable ID of the member (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(groupKey, memberKey, x__xgafv=None)
Retrieve Group Member

Args:
  groupKey: string, Email or immutable ID of the group (required)
  memberKey: string, Email or immutable ID of the member (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
      "type": "A String", # Type of member (Immutable)
      "kind": "admin#directory#member", # Kind of resource this is.
      "role": "A String", # Role of member
      "status": "A String", # Status of member (Immutable)
      "delivery_settings": "A String", # Delivery settings of member
      "id": "A String", # Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey.
      "etag": "A String", # ETag of the resource.
      "email": "A String", # Email of member (Read-only)
    }
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)
Add user to the specified group.

Args:
  groupKey: string, Email or immutable ID of the group (required)
  body: object, The request body.
    The object takes the form of:

{
    "type": "A String", # Type of member (Immutable)
    "kind": "admin#directory#member", # Kind of resource this is.
    "role": "A String", # Role of member
    "status": "A String", # Status of member (Immutable)
    "delivery_settings": "A String", # Delivery settings of member
    "id": "A String", # Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey.
    "etag": "A String", # ETag of the resource.
    "email": "A String", # Email of member (Read-only)
  }

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

Returns:
  An object of the form:

    {
      "type": "A String", # Type of member (Immutable)
      "kind": "admin#directory#member", # Kind of resource this is.
      "role": "A String", # Role of member
      "status": "A String", # Status of member (Immutable)
      "delivery_settings": "A String", # Delivery settings of member
      "id": "A String", # Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey.
      "etag": "A String", # ETag of the resource.
      "email": "A String", # Email of member (Read-only)
    }
list(groupKey, roles=None, pageToken=None, maxResults=None, includeDerivedMembership=None, x__xgafv=None)
Retrieve all members in a group (paginated)

Args:
  groupKey: string, Email or immutable ID of the group (required)
  roles: string, Comma separated role values to filter list results on.
  pageToken: string, Token to specify next page in the list
  maxResults: integer, Maximum number of results to return. Max allowed value is 200.
  includeDerivedMembership: boolean, Whether to list indirect memberships. Default: false.
  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.
    "nextPageToken": "A String", # Token used to access next page of this result.
    "members": [ # List of member objects.
      {
          "type": "A String", # Type of member (Immutable)
          "kind": "admin#directory#member", # Kind of resource this is.
          "role": "A String", # Role of member
          "status": "A String", # Status of member (Immutable)
          "delivery_settings": "A String", # Delivery settings of member
          "id": "A String", # Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey.
          "etag": "A String", # ETag of the resource.
          "email": "A String", # Email of member (Read-only)
        },
    ],
    "kind": "admin#directory#members", # Kind of resource this is.
  }
list_next(previous_request, previous_response)
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)
Patch Member via Apiary Patch Orchestration

Args:
  groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required)
  memberKey: string, Email or immutable ID of the user. If ID, it should match with id of member object (required)
  body: object, The request body.
    The object takes the form of:

{
    "type": "A String", # Type of member (Immutable)
    "kind": "admin#directory#member", # Kind of resource this is.
    "role": "A String", # Role of member
    "status": "A String", # Status of member (Immutable)
    "delivery_settings": "A String", # Delivery settings of member
    "id": "A String", # Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey.
    "etag": "A String", # ETag of the resource.
    "email": "A String", # Email of member (Read-only)
  }

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

Returns:
  An object of the form:

    {
      "type": "A String", # Type of member (Immutable)
      "kind": "admin#directory#member", # Kind of resource this is.
      "role": "A String", # Role of member
      "status": "A String", # Status of member (Immutable)
      "delivery_settings": "A String", # Delivery settings of member
      "id": "A String", # Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey.
      "etag": "A String", # ETag of the resource.
      "email": "A String", # Email of member (Read-only)
    }
update(groupKey, memberKey, body=None, x__xgafv=None)
Update membership of a user in the specified group.

Args:
  groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required)
  memberKey: string, Email or immutable ID of the user. If ID, it should match with id of member object (required)
  body: object, The request body.
    The object takes the form of:

{
    "type": "A String", # Type of member (Immutable)
    "kind": "admin#directory#member", # Kind of resource this is.
    "role": "A String", # Role of member
    "status": "A String", # Status of member (Immutable)
    "delivery_settings": "A String", # Delivery settings of member
    "id": "A String", # Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey.
    "etag": "A String", # ETag of the resource.
    "email": "A String", # Email of member (Read-only)
  }

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

Returns:
  An object of the form:

    {
      "type": "A String", # Type of member (Immutable)
      "kind": "admin#directory#member", # Kind of resource this is.
      "role": "A String", # Role of member
      "status": "A String", # Status of member (Immutable)
      "delivery_settings": "A String", # Delivery settings of member
      "id": "A String", # Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey.
      "etag": "A String", # ETag of the resource.
      "email": "A String", # Email of member (Read-only)
    }