List Roles
const url = 'https://example.com/iam/v1/roles';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/iam/v1/rolesReturns a paginated list of roles
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”The maximum number of roles to return. The service may return fewer than this value. If unspecified, at most 20 roles will be returned. The maximum value is 100; values above 100 will be coerced to 100.
A page token, received from a previous ListRoles call.
Provide this to retrieve the subsequent page. When paginating,
all other parameters provided to ListRoles must match the call
that provided the page token.
AIP-160 filter expression. Filterable fields: create_time, display_name, id, name, role_type, scope_id, scope_type, stage, update_time.
AIP-132 order_by expression. Sortable fields: create_time, display_name, name, role_type, stage, update_time.
AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).
Responses
Section titled “ Responses ”OK
ListRolesResponse
Response message for ListRoles.
object
The list of roles
Role resource: a named collection of permissions assignable to principals
object
The unique identifier of the role
The handle of the role, e.g. “billing-viewer”. Lowercase letters, digits and hyphens; letter-initial; no adjacent hyphens. Parent-scoped-unique. Used to address the role by name or id.
A human-readable label for the role, e.g. “Billing Viewer”. Free text in any script. Never used to address the role. Optional; defaults to the handle (name) when omitted.
An optional description of the role
The type of role (system or custom)
The lifecycle stage of the role
The type of scope this role is defined in (only for custom roles)
The ID of the scoped resource (only for custom roles)
Created Timestamp
The timestamp when the role was created
Updated Timestamp
Timestamp when the Role was last updated
A token, which can be sent as page_token to retrieve the next page.
If this field is empty, there are no subsequent pages.
Exact count of resources matching the request’s filter and scope (both pagination modes).
Example
{ "roles": [ { "role_type": "ROLE_TYPE_UNSPECIFIED", "stage": "ROLE_STAGE_UNSPECIFIED", "scope_type": "SCOPE_TYPE_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
object
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}