Подключиться
Yandex Identity and Access Management

Метод list

Возвращает список сертификатов для указанной федерации.

HTTP-запрос

GET https://iam.api.cloud.yandex.net/iam/v1/saml/certificates

Query-параметры

Параметр Описание
federationId Обязательное поле. Идентификатор федерации для получения списка сертификатов. Чтобы получить идентификатор федерации, используйте запрос [yandex.cloud.iam.v1.FederationService.List]. Максимальная длина строки в символах — 50.
pageSize Максимальное количество результатов на странице ответа на запрос. Если количество результатов больше чем pageSize , сервис вернет значение nextPageToken, которое можно использовать для получения следующей страницы. Значение по умолчанию: 100. Допустимые значения — от 0 до 1000 включительно.
pageToken Токен страницы. Установите значение pageToken равным значению поля nextPageToken предыдущего запроса, чтобы получить следующую страницу результатов. Максимальная длина строки в символах — 100.
filter Параметры фильтрации ресурсов в ответе. В параметрах фильтрации указываются: 1. Имя поля. В настоящее время фильтрация осуществляется только по полю Certificate.name. 2. Оператор. Операторы = или != для одиночных значений, IN или NOT IN для списков значений. 3. Значение. Значение длиной от 3 до 63 символов, совпадающее с регулярным выражением ^[a-z][-a-z0-9]{1,61}[a-z0-9]$. Максимальная длина строки в символах — 1000.

Ответ

HTTP Code: 200 - OK

{
  "certificates": [
    {
      "id": "string",
      "federationId": "string",
      "name": "string",
      "description": "string",
      "createdAt": "string",
      "data": "string"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
certificates[] object

Сертификат.
certificates[].
id		 string

Обязательное поле. Идентификатор сертификата.

Максимальная длина строки в символах — 50.
certificates[].
federationId		 string

Обязательное поле. Идентификатор федерации, которой принадлежит сертификат.

Максимальная длина строки в символах — 50.
certificates[].
name		 string

Имя сертификата.

Значение должно соответствовать регулярному выражению |[a-z][-a-z0-9]{1,61}[a-z0-9].
certificates[].
description		 string

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

Максимальная длина строки в символах — 256.
certificates[].
createdAt		 string (date-time)

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

Строка в формате RFC3339.
certificates[].
data		 string

Обязательное поле. Данные сертификата в формате PEM.

Максимальная длина строки в символах — 32000.
nextPageToken string

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