Метод list
Возвращает список доступных ресурсов Key для указанного сервисного аккаунта.
HTTP-запрос
GET https://iam.api.cloud.yandex.net/iam/v1/keys
Query-параметры
Параметр | Описание |
---|---|
format | Формат ключа.
|
serviceAccountId | Идентификатор сервисного аккаунта для вывода списка пар ключей. Чтобы получить идентификатор сервисного аккаунта, используйте запрос list. Если параметр не указан, то используется идентификатор субъекта, который сделал запрос. Максимальная длина строки в символах — 50. |
pageSize | Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize, сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Максимальное значение — 1000. |
pageToken | Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100. |
Ответ
HTTP Code: 200 - OK
{
"keys": [
{
"id": "string",
"createdAt": "string",
"description": "string",
"keyAlgorithm": "string",
"publicKey": "string",
// `keys[]` включает только одно из полей `userAccountId`, `serviceAccountId`
"userAccountId": "string",
"serviceAccountId": "string",
// конец списка возможных полей`keys[]`
}
],
"nextPageToken": "string"
}
Поле | Описание |
---|---|
keys[] | object Ресурс Key. Подробнее см. в разделе Авторизованные ключи. |
keys[]. id |
string Идентификатор ресурса Key |
keys[]. createdAt |
string (date-time) Время создания. Строка в формате RFC3339. |
keys[]. description |
string Описание ресурса Key. Длина 0-256 символов. |
keys[]. keyAlgorithm |
string Алгоритм, используемый для создания пары ключей ресурса Key.
|
keys[]. publicKey |
string Закрытый ключ из ресурса Key. |
keys[]. userAccountId |
string keys[] включает только одно из полей userAccountId , serviceAccountId Идентификатор аккаунта пользователя, которому принадлежит ресурс Key. |
keys[]. serviceAccountId |
string keys[] включает только одно из полей userAccountId , serviceAccountId Идентификатор сервисного аккаунта, которому принадлежит ресурс Key. |
nextPageToken | string Токен для получения следующей страницы результатов в ответе. Если количество результатов больше чем pageSize, используйте nextPageToken в качестве значения параметра pageToken в следующем запросе списка ресурсов. Все последующие запросы будут получать свои значения nextPageToken для перебора страниц результатов. |