Метод update

Обновляет федерацию.

HTTP-запрос

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

Path-параметры

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

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

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

Маска, определяющая, какие поля ресурса федерации будут обновлены.

Имена всех обновляемых полей, разделенные запятыми. Только значения указанных полей будут изменены. Остальные останутся нетронутыми. Если поле указано в параметре updateMask и в запросе не было отправлено значение для этого поля, значение поля будет сброшено на значение по умолчанию. Значение по умолчанию для большинства полей — null или 0.

Если в запросе не передается updateMask, значения всех полей будут обновлены. Для полей, указанных в запросе, будут использованы переданные значения. Значения остальных полей будут сброшены на значения по умолчанию.

name string

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

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

description string

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

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

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.

Ответ

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.