Yandex.Cloud
  • Сервисы
  • Почему Yandex.Cloud
  • Сообщество
  • Решения
  • Тарифы
  • Документация
  • Связаться с нами
Подключиться
Yandex Identity and Access Management
  • Начало работы
    • Как управлять доступом к ресурсам
    • Как работать с сервисными аккаунтами
  • Пошаговые инструкции
    • Все инструкции
    • Пользователи
      • Добавление пользователя
      • Получение идентификатора или почты пользователя
      • Удаление пользователя
    • Сервисные аккаунты
      • Создание сервисного аккаунта
      • Изменение сервисного аккаунта
      • Назначение роли сервисному аккаунту
      • Настройка прав доступа к сервисному аккаунту
      • Создание статических ключей доступа
      • Получение идентификатора сервисного аккаунта
      • Удаление сервисного аккаунта
    • Федерации удостоверений
      • Аутентификация с помощью Active Directory
      • Аутентификация с помощью G-Suite
      • Аутентификация с помощью федерации удостоверений
      • Добавление пользователей
    • Роли
      • Назначение роли
      • Просмотр назначенных ролей
      • Отзыв роли
    • IAM-токены
      • Получение IAM-токена для аккаунта на Яндексе
      • Получение IAM-токена для сервисного аккаунта
      • Получение IAM-токена для федеративного аккаунта
    • Ключи
      • Создание API-ключа
      • Удаление API-ключа
      • Создание авторизованного ключа
  • Концепции
    • Обзор
    • Как устроено управление доступом
      • Обзор
      • Роли
      • Системные группы
      • Ресурсы, на которые можно назначать роли
    • Авторизация
      • Обзор
      • IAM-токен
      • OAuth-токен
      • API-ключ
      • Авторизованные ключи
      • AWS-совместимые ключи доступа
    • Сервисные аккаунты
    • SAML-совместимые федерации удостоверений
    • Квоты и лимиты
  • Безопасное использование Yandex.Cloud
  • Управление доступом
  • Правила тарификации
  • Справочник API
    • Аутентификация в API
    • gRPC
      • Обзор
      • ApiKeyService
      • IamTokenService
      • KeyService
      • RoleService
      • ServiceAccountService
      • UserAccountService
      • YandexPassportUserAccountService
      • AccessKeyService
      • CertificateService
      • FederationService
      • OperationService
    • REST
      • Обзор
      • ApiKey
        • Обзор
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • IamToken
        • Обзор
        • create
      • Key
        • Обзор
        • create
        • delete
        • get
        • list
        • listOperations
        • update
      • Role
        • Обзор
        • get
        • list
      • ServiceAccount
        • Обзор
        • create
        • delete
        • get
        • list
        • listAccessBindings
        • listOperations
        • setAccessBindings
        • update
        • updateAccessBindings
      • UserAccount
        • Обзор
        • get
      • YandexPassportUserAccount
        • Обзор
        • getByLogin
      • Operation
        • Обзор
        • get
      • Federation
        • Обзор
        • update
        • list
        • listUserAccounts
        • get
        • delete
        • addUserAccounts
        • create
        • listOperations
      • Certificate
        • Обзор
        • update
        • list
        • get
        • delete
        • create
        • listOperations
      • AccessKey
        • Обзор
        • update
        • list
        • get
        • delete
        • create
        • listOperations
  • Вопросы и ответы
    • Общие вопросы
    • Вход в систему и доступ к ресурсам
    • Все вопросы на одной странице
  1. Справочник API
  2. REST
  3. Federation
  4. get

Метод 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",
  "securitySettings": {
    "encryptedAssertions": true
  },
  "caseInsensitiveNameIds": true
}

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

Поле Описание
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 пользователей.

В этой статье:
  • HTTP-запрос
  • Path-параметры
  • Ответ
Language
Вакансии
Политика конфиденциальности
Условия использования
© 2021 ООО «Яндекс.Облако»