Метод list

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

HTTP-запрос

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

Query-параметры

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

Ответ

HTTP Code: 200 - OK

{
  "federations": [
    {
      "id": "string",
      "folderId": "string",
      "name": "string",
      "description": "string",
      "createdAt": "string",
      "cookieMaxAge": "string",
      "autoCreateAccountOnLogin": true,
      "issuer": "string",
      "ssoBinding": "string",
      "ssoUrl": "string"
    }
  ],
  "nextPageToken": "string"
}
Поле Описание
federations[] object

Федерация. Дополнительные сведения см. в разделе SAML-совместимые федерации удостоверений.

federations[].
id
string

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

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

federations[].
folderId
string

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

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

federations[].
name
string

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

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

federations[].
description
string

Описание федерации.

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

federations[].
createdAt
string (date-time)

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

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

federations[].
cookieMaxAge
string

Время жизни файлов cookie в браузере в секундах. Если время жизни cookie не истекло, то консоль управления сразу аутентифицирует пользователя и отправляет на главную страницу.

Допустимые значения — от 600 seconds до 43200 seconds включительно.

federations[].
autoCreateAccountOnLogin
boolean (boolean)

Добавлять новых пользователей автоматически при успешной аутентификации. Пользователям будет назначена роль resource-manager.clouds.member автоматически, но остальные роли надо будет назначить самостоятельно.

Если значение false , то пользователь, которого не добавили в облако, не сможет войти, даже если пройдет аутентификацию на вашем сервере.

federations[].
issuer
string

Обязательное поле. Идентификатор IdP-сервера, который будет использоваться для аутентификации. Этот же идентификатор сервер IdP указывает в ответе после того, как пользователь проходит аутентификацию.

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

federations[].
ssoBinding
string

Тип привязки для Single Sign-on. Большинство поставщиков поддерживают тип привязки POST.

Привязка — это отображение сообщения протокола SAML на стандартные форматы сообщений и / или протоколы связи.

  • POST: Привязка HTTP POST.
  • REDIRECT: Привязка перенаправлением HTTP.
  • ARTIFACT: Привязка артефактом HTTP.
federations[].
ssoUrl
string

Обязательное поле. URL для Single sign-on. Укажите здесь ссылку на страницу для входа в IdP.

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

nextPageToken string

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