List
|
|||||
|
|
Lists the Roles defined on a resource
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
Input
This building block consumes 5 input parameters
Name | Format | Description |
---|---|---|
showDeleted |
BOOLEAN |
Include Roles that have been deleted |
pageToken |
STRING |
Optional pagination token returned in an earlier ListRolesResponse |
pageSize |
INTEGER |
Optional limit on the number of roles to include in the response |
view |
ENUMERATION |
Optional view for the returned Role objects. When |
parent |
STRING |
The resource name of the parent resource in one of the following formats:
`` (empty string) -- this refers to curated roles.
|
= Parameter name
= Format
showDeleted BOOLEAN Include Roles that have been deleted |
pageToken STRING Optional pagination token returned in an earlier ListRolesResponse |
pageSize INTEGER Optional limit on the number of roles to include in the response |
view ENUMERATION Optional view for the returned Role objects. When |
parent STRING The resource name of the parent resource in one of the following formats:
`` (empty string) -- this refers to curated roles.
|
Output
This building block provides 9 output parameters
Name | Format | Description |
---|---|---|
roles[] |
OBJECT |
A role in the Identity and Access Management API |
roles[].title |
STRING |
Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes |
roles[].includedPermissions[] |
STRING |
|
roles[].description |
STRING |
Optional. A human-readable description for the role |
roles[].etag |
BINARY |
Used to perform a consistent read-modify-write |
roles[].stage |
ENUMERATION |
The current launch stage of the role. If the |
roles[].name |
STRING |
The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for curated roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles |
roles[].deleted |
BOOLEAN |
The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole |
nextPageToken |
STRING |
To retrieve the next page of results, set
|
= Parameter name
= Format
roles[] OBJECT A role in the Identity and Access Management API |
roles[].title STRING Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes |
roles[].includedPermissions[] STRING |
roles[].description STRING Optional. A human-readable description for the role |
roles[].etag BINARY Used to perform a consistent read-modify-write |
roles[].stage ENUMERATION The current launch stage of the role. If the |
roles[].name STRING The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for curated roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles |
roles[].deleted BOOLEAN The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole |
nextPageToken STRING To retrieve the next page of results, set
|