Метод create

Создает федерацию в указанном каталоге.

HTTP-запрос

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

Параметры в теле запроса

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

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

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

name string

Название федерации. Имя должно быть уникальным в облаке.

Значение должно соответствовать регулярному выражению a-z?.

description string

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

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

cookieMaxAge string

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

Допустимые значения — от 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.

Ответ

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": true,
  "metadata": "object",

  //  включает только одно из полей `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": "object",
  // конец списка возможных полей

}

Ресурс Operation. Дополнительные сведения см. в разделе Объект Operation.

Поле Описание
id string

Идентификатор операции.

description string

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

createdAt string (date-time)

Время создания ресурса в формате в RFC3339.

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

createdBy string

Идентификатор пользователя или сервисного аккаунта, инициировавшего операцию.

modifiedAt string (date-time)

Время, когда ресурс Operation последний раз обновлялся. Значение в формате RFC3339.

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

done boolean (boolean)

Если значение равно false — операция еще выполняется. Если true — операция завершена, и задано значение одного из полей error или response.

metadata object

Метаданные операции. Обычно в поле содержится идентификатор ресурса, над которым выполняется операция. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля metadata.

error object
Описание ошибки в случае сбоя или отмены операции.
включает только одно из полей error, response

Описание ошибки в случае сбоя или отмены операции.

error.
code
integer (int32)

Код ошибки. Значение из списка google.rpc.Code.

error.
message
string

Текст ошибки.

error.
details[]
object

Список сообщений с подробными сведениями об ошибке.

response object
включает только одно из полей error, response

Результат операции в случае успешного завершения. Если исходный метод не возвращает никаких данных при успешном завершении, например метод Delete, поле содержит объект google.protobuf.Empty. Если исходный метод — это стандартный метод Create / Update, поле содержит целевой ресурс операции. Если метод возвращает ресурс Operation, в описании метода приведена структура соответствующего ему поля response.