Returns the aliases Resource.
Delete Group
Retrieve Group
Create Group
Retrieve all groups of a domain or of a user given a userKey (paginated)
list_next(previous_request=*, previous_response=*)
Retrieves the next page of results.
Update Group. This method supports patch semantics.
Update Group
delete(groupKey=*)
Delete Group Args: groupKey: string, Email or immutable ID of the group (required)
get(groupKey=*)
Retrieve Group
Args:
groupKey: string, Email or immutable ID of the group (required)
Returns:
An object of the form:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}
insert(body=None)
Create Group
Args:
body: object, The request body.
The object takes the form of:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}
Returns:
An object of the form:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}
list(customer=None, orderBy=None, domain=None, pageToken=None, maxResults=None, sortOrder=None, query=None, userKey=None)
Retrieve all groups of a domain or of a user given a userKey (paginated)
Args:
customer: string, Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.
orderBy: string, Column to use for sorting results
Allowed values
email - Email of the group.
domain: string, Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.
pageToken: string, Token to specify next page in the list
maxResults: integer, Maximum number of results to return. Max allowed value is 200.
sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
Allowed values
ASCENDING - Ascending order.
DESCENDING - Descending order.
query: string, Query string search. Should be of the form "". Complete documentation is at https://developers.google.com/admin-sdk/directory/v1/guides/search-groups
userKey: string, Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.
Returns:
An object of the form:
{ # JSON response template for List Groups operation in Directory API.
"nextPageToken": "A String", # Token used to access next page of this result.
"kind": "admin#directory#groups", # Kind of resource this is.
"etag": "A String", # ETag of the resource.
"groups": [ # List of group objects.
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
},
],
}
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=*, body=None)
Update Group. This method supports patch semantics.
Args:
groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}
Returns:
An object of the form:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}
update(groupKey=*, body=None)
Update Group
Args:
groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required)
body: object, The request body.
The object takes the form of:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}
Returns:
An object of the form:
{ # JSON template for Group resource in Directory API.
"nonEditableAliases": [ # List of non editable aliases (Read-only)
"A String",
],
"kind": "admin#directory#group", # Kind of resource this is.
"description": "A String", # Description of the group
"name": "A String", # Group name
"adminCreated": True or False, # Is the group created by admin (Read-only) *
"directMembersCount": "A String", # Group direct members count
"id": "A String", # Unique identifier of Group (Read-only)
"etag": "A String", # ETag of the resource.
"email": "A String", # Email of Group
"aliases": [ # List of aliases (Read-only)
"A String",
],
}