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

Federation

Набор методов для управления федерациями.

JSON-представление

{
  "id": "string",
  "folderId": "string",
  "name": "string",
  "description": "string",
  "createdAt": "string",
  "cookieMaxAge": "string",
  "autoCreateAccountOnLogin": true,
  "issuer": "string",
  "ssoBinding": "string",
  "ssoUrl": "string",
  "securitySettings": {
    "encryptedAssertions": true
  },
  "caseInsensitiveNameIds": true
}
Поле Описание
id string

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Настройки безопасности федерации.

Настройки безопасности федерации.
securitySettings.
encryptedAssertions		 boolean (boolean)

Включить шифрование утверждений.
caseInsensitiveNameIds boolean (boolean)

Использовать нечувствительные к регистру Name ID пользователей.

Методы

Метод Описание
addUserAccounts Добавляет пользователей в указанную федерацию.
create Создает федерацию в указанном каталоге.
delete Удаляет указанную федерацию.
get Возвращает указанную федерацию.
list Возвращает список федераций в указанном каталоге.
listOperations Возвращает список операций для указанной федерации.
update Изменяет указанную федерацию.
В этой статье: