Метод list

Возвращает список доступных ресурсов Role.

HTTP-запрос

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

Query-параметры

Параметр Описание
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter Параметры фильтрации ресурсов в ответе. Максимальная длина строки в символах — 1000.

Ответ

HTTP Code: 200 - OK

{
  "roles": [
    {
      "id": "string",
      "description": "string"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
roles[] object

Ресурс Role. Подробнее см. в разделе Роли.

roles[].
id
string

Идентификатор роли.

roles[].
description
string

Описание роли. Длина описания должна быть от 0 до 256 символов.

nextPageToken string

Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов.