[Yandex Cloud documentation](../../../../index.md) > [Yandex Identity Hub](../../../index.md) > API reference > REST > [SAML Federation API](../index.md) > [Federation](index.md) > Update # SAML Federation API, REST: Federation.Update Updates the specified federation. ## HTTP request ``` PATCH https://organization-manager.api.cloud.yandex.net/organization-manager/v1/saml/federations/{federationId} ``` ## Path parameters #| ||Field | Description || || federationId | **string** Required field. ID of the federation to update. To get the federation ID, make a [FederationService.List](list.md#List) request. The maximum string length in characters is 50. || |# ## Body parameters {#yandex.cloud.organizationmanager.v1.saml.UpdateFederationRequest} ```json { "updateMask": "string", "name": "string", "description": "string", "cookieMaxAge": "string", "autoCreateAccountOnLogin": "boolean", "issuer": "string", "ssoBinding": "string", "ssoUrl": "string", "securitySettings": { "encryptedAssertions": "boolean", "forceAuthn": "boolean" }, "caseInsensitiveNameIds": "boolean", "labels": "object" } ``` #| ||Field | Description || || updateMask | **string** (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `` updateMask `` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `` updateMask `` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default. || || name | **string** Name of the federation. The name must be unique within the organization. Value must match the regular expression ``` |[a-z]([-a-z0-9]{0,61}[a-z0-9])? ```. || || description | **string** Description of the federation. The maximum string length in characters is 256. || || cookieMaxAge | **string** (duration) Browser cookie lifetime in seconds. If the cookie is still valid, the management console authenticates the user immediately and redirects them to the home page. The default value is `8h`. || || autoCreateAccountOnLogin | **boolean** Add new users automatically on successful authentication. The user becomes member of the organization automatically, but you need to grant other roles to them. If the value is `false`, users who aren't added to the organization can't log in, even if they have authenticated on your server. || || issuer | **string** ID of the IdP server to be used for authentication. The IdP server also responds to IAM with this ID after the user authenticates. The maximum string length in characters is 8000. || || ssoBinding | **enum** (BindingType) Single sign-on endpoint binding type. Most Identity Providers support the `POST` binding type. SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols. - `POST`: HTTP POST binding. - `REDIRECT`: HTTP redirect binding. - `ARTIFACT`: HTTP artifact binding. || || ssoUrl | **string** Single sign-on endpoint URL. Specify the link to the IdP login page here. The maximum string length in characters is 8000. || || securitySettings | **[FederationSecuritySettings](#yandex.cloud.organizationmanager.v1.saml.FederationSecuritySettings)** Federation security settings. || || caseInsensitiveNameIds | **boolean** Use case insensitive name ids. || || labels | **object** (map<**string**, **string**>) Resource labels as `` key:value `` pairs. The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression ` [a-z][-_0-9a-z]* `. Each value must match the regular expression ` [-_0-9a-z]* `. No more than 64 per resource. || |# ## FederationSecuritySettings {#yandex.cloud.organizationmanager.v1.saml.FederationSecuritySettings} Federation security settings. #| ||Field | Description || || encryptedAssertions | **boolean** Enable encrypted assertions. || || forceAuthn | **boolean** Value parameter ForceAuthn in SAMLRequest. || |# ## Response {#yandex.cloud.operation.Operation} **HTTP Code: 200 - OK** ```json { "id": "string", "description": "string", "createdAt": "string", "createdBy": "string", "modifiedAt": "string", "done": "boolean", "metadata": "object", // Includes only one of the fields `error`, `response` "error": { "code": "integer", "message": "string", "details": [ "object" ] }, "response": "object" // end of the list of possible fields } ``` An Operation resource. For more information, see [Operation](../../../../api-design-guide/concepts/operation.md). #| ||Field | Description || || id | **string** ID of the operation. || || description | **string** Description of the operation. 0-256 characters long. || || createdAt | **string** (date-time) Creation timestamp. String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || createdBy | **string** ID of the user or service account who initiated the operation. || || modifiedAt | **string** (date-time) The time when the Operation resource was last modified. String in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the [Protocol Buffers reference](https://developers.google.com/protocol-buffers/docs/reference/overview). In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). || || done | **boolean** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. || || metadata | **object** Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. || || error | **[Status](#google.rpc.Status)** The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set. || || response | **object** The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is [google.protobuf.Empty](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Empty). If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set. || |# ## Status {#google.rpc.Status} The error result of the operation in case of failure or cancellation. #| ||Field | Description || || code | **integer** (int32) Error code. An enum value of [google.rpc.Code](https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto). || || message | **string** An error message. || || details[] | **object** A list of messages that carry the error details. || |#