Contact UsGet started

Identity and Access Management API, gRPC: RoleService.List

Written by
Updated at November 26, 2024

Retrieves the list of Role resources.

gRPC request

rpc List (ListRolesRequest) returns (ListRolesResponse)

ListRolesRequest

{
  "page_size": "int64",
  "page_token": "string",
  "filter": "string"
}

Field

Description

page_size

int64

The maximum number of results per page to return. If the number of available
results is larger than page_size,
the service returns a ListRolesResponse.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value: 100.

page_token

string

Page token. To get the next page of results, set page_token
to the ListRolesResponse.next_page_token
returned by a previous list request.

filter

string

A filter expression that filters resources listed in the response.

ListRolesResponse

{
  "roles": [
    {
      "id": "string",
      "description": "string"
    }
  ],
  "next_page_token": "string"
}

Field

Description

roles[]

Role

List of Role resources.

next_page_token

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListRolesRequest.page_size, use
the next_page_token as the value
for the ListRolesRequest.page_token query parameter
in the next list request. Each subsequent list request will have its own
next_page_token to continue paging through the results.

Role

A Role resource. For more information, see Roles.

Field

Description

id

string

ID of the role.

description

string

Description of the role. 0-256 characters long.
Previous
Get
Next
Overview