Метод list

Возвращает список API-ключей для указанного сервисного аккаунта.

HTTP-запрос

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

Query-параметры

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

Ответ

HTTP Code: 200 - OK

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

Ресурс ApiKey.

apiKeys[].
id
string

Идентификатор API-ключа.

apiKeys[].
serviceAccountId
string

Идентификатор сервисного аккаунта, которому принадлежит API-ключ.

apiKeys[].
createdAt
string (date-time)

Время создания.

Строка в формате RFC3339.

apiKeys[].
description
string

Описание API-ключа. Длина описания должна быть от 0 до 256 символов.

nextPageToken string

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