List
|
|||||
|
|
Retrieves a paginated list of all roleAssignments
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage delegated admin roles for your domain
- View delegated admin roles for your domain
Input
This building block consumes 5 input parameters
Name | Format | Description |
---|---|---|
customer Required |
STRING |
Immutable ID of the G Suite account |
roleId |
STRING |
Immutable ID of a role. If included in the request, returns only role assignments containing this role ID |
pageToken |
STRING |
Token to specify the next page in the list |
maxResults |
INTEGER |
Maximum number of results to return |
userKey |
STRING |
The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user |
= Parameter name
= Format
customer STRING Required Immutable ID of the G Suite account |
roleId STRING Immutable ID of a role. If included in the request, returns only role assignments containing this role ID |
pageToken STRING Token to specify the next page in the list |
maxResults INTEGER Maximum number of results to return |
userKey STRING The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user |
Output
This building block provides 11 output parameters
Name | Format | Description |
---|---|---|
etag |
STRING |
ETag of the resource |
kind |
STRING |
The type of the API resource. This is always admin#directory#roleAssignments |
items[] |
OBJECT |
|
items[].scopeType |
STRING |
The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT |
items[].kind |
STRING |
The type of the API resource. This is always admin#directory#roleAssignment |
items[].roleId |
INTEGER |
The ID of the role that is assigned |
items[].roleAssignmentId |
INTEGER |
ID of this roleAssignment |
items[].etag |
STRING |
ETag of the resource |
items[].assignedTo |
STRING |
The unique ID of the user this role is assigned to |
items[].orgUnitId |
STRING |
If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to |
nextPageToken |
STRING |
= Parameter name
= Format
etag STRING ETag of the resource |
kind STRING The type of the API resource. This is always admin#directory#roleAssignments |
items[] OBJECT |
items[].scopeType STRING The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT |
items[].kind STRING The type of the API resource. This is always admin#directory#roleAssignment |
items[].roleId INTEGER The ID of the role that is assigned |
items[].roleAssignmentId INTEGER ID of this roleAssignment |
items[].etag STRING ETag of the resource |
items[].assignedTo STRING The unique ID of the user this role is assigned to |
items[].orgUnitId STRING If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to |
nextPageToken STRING |