Метод get

HTTP-запрос
Path-параметры
Ответ

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

Чтобы получить список доступных ресурсов федераций, используйте запрос list.

HTTP-запрос

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

Path-параметры

Параметр	Описание
federationId	Идентификатор возвращаемого ресурса федерации. Чтобы получить идентификатор федерации, используйте запрос list. Максимальная длина строки в символах — 50.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "folderId": "string",
  "name": "string",
  "description": "string",
  "createdAt": "string",
  "cookieMaxAge": "string",
  "autoCreateAccountOnLogin": true,
  "issuer": "string",
  "ssoBinding": "string",
  "ssoUrl": "string"
}

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

Поле	Описание
id	string Обязательное поле. Идентификатор федерации. Максимальная длина строки в символах — 50.
folderId	string Обязательное поле. Идентификатор каталога, которому принадлежит федерация. Максимальная длина строки в символах — 50.
name	string Обязательное поле. Имя федерации. Имя должно быть уникальным в каталоге. Длина 3-63 символов. Значение должно соответствовать регулярному выражению `\|[a-z][-a-z0-9]{1,61}[a-z0-9]`.
description	string Описание федерации. Длина описания должна быть от 0 до 256 символов. Максимальная длина строки в символах — 256.
createdAt	string (date-time) Время создания. Строка в формате RFC3339.
cookieMaxAge	string Максимальное время жизни токена 'IAM_COOKIE'. Должно быть в интервале от 10 min до 12 часов. Значение по умолчанию: 8 часов. Допустимые значения — от 600 seconds до 43200 seconds включительно.
autoCreateAccountOnLogin	boolean (boolean) Автоматически создавать аккаунты для новых пользователей после успешной аутентификации.
issuer	string Обязательное поле. Идентификатор IdP-сервера (entity Id). Максимальная длина строки в символах — 8000.
ssoBinding	string Тип привязки IdP. Привязка SAML — это отображение сообщения протокола SAML на стандартные форматы сообщений и / или протоколы связи. BINDING_TYPE_UNSPECIFIED: Не указано. POST: Привязка HTTP POST. REDIRECT: Привязка перенаправлением HTTP. ARTIFACT: Привязка артифактом HTTP.
ssoUrl	string Обязательное поле. Ссылка на страницу для входа в IdP. Максимальная длина строки в символах — 8000.