List
|
|||||
|
|
||||
Retrieve all groups of a domain or of a user given a userKey (paginated)
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage the provisioning of groups on your domain
- View groups on your domain
Input
This building block consumes 8 input parameters
| Name | Format | Description |
|---|---|---|
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 |
ENUMERATION |
Column to use for sorting results |
pageToken |
STRING |
Token to specify next page in the list |
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 |
maxResults |
INTEGER |
Maximum number of results to return. Max allowed value is 200 |
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 |
sortOrder |
ENUMERATION |
Whether to return results in ascending or descending order. Only of use when orderBy is also used |
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 |
= Parameter name
= Format
|
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 ENUMERATION Column to use for sorting results |
|
pageToken STRING Token to specify next page in the list |
|
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 |
|
maxResults INTEGER Maximum number of results to return. Max allowed value is 200 |
|
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 |
|
sortOrder ENUMERATION Whether to return results in ascending or descending order. Only of use when orderBy is also used |
|
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 |
Output
This building block provides 14 output parameters
| Name | Format | Description |
|---|---|---|
nextPageToken |
STRING |
Token used to access next page of this result |
kind |
STRING |
Kind of resource this is |
etag |
STRING |
ETag of the resource |
groups[] |
OBJECT |
STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) |
groups[].description |
STRING |
Description of the group |
groups[].nonEditableAliases[] |
STRING |
|
groups[].email |
STRING |
Email of Group |
groups[].aliases[] |
STRING |
|
groups[].kind |
STRING |
Kind of resource this is |
groups[].etag |
STRING |
ETag of the resource |
groups[].id |
STRING |
Unique identifier of Group (Read-only) |
groups[].name |
STRING |
Group name |
groups[].adminCreated |
BOOLEAN |
Is the group created by admin (Read-only) * |
groups[].directMembersCount |
INTEGER |
Group direct members count |
= Parameter name
= Format
|
nextPageToken STRING Token used to access next page of this result |
|
kind STRING Kind of resource this is |
|
etag STRING ETag of the resource |
|
groups[] OBJECT STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber) |
|
groups[].description STRING Description of the group |
|
groups[].nonEditableAliases[] STRING |
|
groups[].email STRING Email of Group |
|
groups[].aliases[] STRING |
|
groups[].kind STRING Kind of resource this is |
|
groups[].etag STRING ETag of the resource |
|
groups[].id STRING Unique identifier of Group (Read-only) |
|
groups[].name STRING Group name |
|
groups[].adminCreated BOOLEAN Is the group created by admin (Read-only) * |
|
groups[].directMembersCount INTEGER Group direct members count |