Method list

Retrieves the list of Role resources.

HTTP request

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

Query parameters

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

Response

HTTP Code: 200 - OK

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

A Role resource. For more information, see Roles.

roles[].
id
string

ID of the role.

roles[].
description
string

Description of the role. 0-256 characters long.

nextPageToken string

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