List
|
|||||
|
|
||||
Retrieves a paginated list of all the roles in a domain
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 3 input parameters
| Name | Format | Description |
|---|---|---|
customer Required |
STRING |
Immutable ID of the G Suite account |
pageToken |
STRING |
Token to specify the next page in the list |
maxResults |
INTEGER |
Maximum number of results to return |
= Parameter name
= Format
|
customer STRING Required Immutable ID of the G Suite account |
|
pageToken STRING Token to specify the next page in the list |
|
maxResults INTEGER Maximum number of results to return |
Output
This building block provides 14 output parameters
| Name | Format | Description |
|---|---|---|
items[] |
OBJECT |
|
items[].rolePrivileges[] |
OBJECT |
|
items[].rolePrivileges[].serviceId |
STRING |
The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list() |
items[].rolePrivileges[].privilegeName |
STRING |
The name of the privilege |
items[].isSuperAdminRole |
BOOLEAN |
Returns true if the role is a super admin role |
items[].roleId |
INTEGER |
ID of the role |
items[].isSystemRole |
BOOLEAN |
Returns true if this is a pre-defined system role |
items[].etag |
STRING |
ETag of the resource |
items[].roleDescription |
STRING |
A short description of the role |
items[].kind |
STRING |
The type of the API resource. This is always admin#directory#role |
items[].roleName |
STRING |
Name of the role |
etag |
STRING |
ETag of the resource |
kind |
STRING |
The type of the API resource. This is always admin#directory#roles |
nextPageToken |
STRING |
= Parameter name
= Format
|
items[] OBJECT |
|
items[].rolePrivileges[] OBJECT |
|
items[].rolePrivileges[].serviceId STRING The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list() |
|
items[].rolePrivileges[].privilegeName STRING The name of the privilege |
|
items[].isSuperAdminRole BOOLEAN Returns true if the role is a super admin role |
|
items[].roleId INTEGER ID of the role |
|
items[].isSystemRole BOOLEAN Returns true if this is a pre-defined system role |
|
items[].etag STRING ETag of the resource |
|
items[].roleDescription STRING A short description of the role |
|
items[].kind STRING The type of the API resource. This is always admin#directory#role |
|
items[].roleName STRING Name of the role |
|
etag STRING ETag of the resource |
|
kind STRING The type of the API resource. This is always admin#directory#roles |
|
nextPageToken STRING |