Identity and Access Management API, REST: Role.List

Written by

Updated at October 17, 2024

HTTP request
Query parameters
Response
Role

Retrieves the list of Role resources.

HTTP request

GET https://iam.api.cloud.yandex.net/iam/v1/roles

Query parameters

Field	Description
pageSize	string (int64) The maximum number of results per page to return. If the number of available results is larger than `pageSize`, the service returns a ListRolesResponse.nextPageToken that can be used to get the next page of results in subsequent list requests. Default value: 100.
pageToken	string Page token. To get the next page of results, set `pageToken` to the ListRolesResponse.nextPageToken returned by a previous list request.
filter	string A filter expression that filters resources listed in the response.

Response

HTTP Code: 200 - OK

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

Field

Description

roles[]

Role

List of Role resources.

nextPageToken

string

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

Role

A Role resource. For more information, see Roles.

Field

Description

string

ID of the role.

description

string

Description of the role. 0-256 characters long.

Identity and Access Management API, REST: Role.List

HTTP requestHTTP request

Query parametersQuery parameters

ResponseResponse

RoleRole

Was the article helpful?

HTTP request

Query parameters

Response

Role