List
|
|||||
|
|
||||
Retrieve all members in a group (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 and manage group subscriptions on your domain
- View group subscriptions on your domain
- View groups on your domain
Input
This building block consumes 5 input parameters
| Name | Format | Description |
|---|---|---|
groupKey Required |
STRING |
Email or immutable ID of the group |
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 |
= Parameter name
= Format
|
groupKey STRING Required Email or immutable ID of the group |
|
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 |
Output
This building block provides 12 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 |
members[] |
OBJECT |
|
members[].email |
STRING |
Email of member (Read-only) |
members[].kind |
STRING |
Kind of resource this is |
members[].delivery_settings |
STRING |
Delivery settings of member |
members[].etag |
STRING |
ETag of the resource |
members[].id |
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 |
members[].type |
STRING |
Type of member (Immutable) |
members[].status |
STRING |
Status of member (Immutable) |
members[].role |
STRING |
Role of member |
= 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 |
|
members[] OBJECT |
|
members[].email STRING Email of member (Read-only) |
|
members[].kind STRING Kind of resource this is |
|
members[].delivery_settings STRING Delivery settings of member |
|
members[].etag STRING ETag of the resource |
|
members[].id 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 |
|
members[].type STRING Type of member (Immutable) |
|
members[].status STRING Status of member (Immutable) |
|
members[].role STRING Role of member |