Identity and Access Management SAML API, REST: Federation.update
Updates the specified federation.
HTTP request
PATCH https://iam.api.cloud.yandex.net/iam/v1/saml/federations/{federationId}
Path parameters
Parameter | Description |
---|---|
federationId | ID of the federation to update. To get the federation ID, make a list request. The maximum string length in characters is 50. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"cookieMaxAge": "string",
"autoCreateAccountOnLogin": true,
"issuer": "string",
"ssoBinding": "string",
"ssoUrl": "string",
"securitySettings": {
"encryptedAssertions": true
},
"caseInsensitiveNameIds": true
}
Field | Description |
---|---|
updateMask | string Field mask that specifies which fields of the federation are going to be updated. 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 If |
name | string Name of the federation. The name must be unique within the cloud. Value must match the regular expression |
description | string Description of the federation. The maximum string length in characters is 256. |
cookieMaxAge | string 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 Acceptable values are 600 seconds to 43200 seconds, inclusive. |
autoCreateAccountOnLogin | boolean (boolean) Add new users automatically on successful authentication. The user will get the If the value is |
issuer | string Required. 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 | string Single sign-on endpoint binding type. Most Identity Providers support the SAML Binding is a mapping of a SAML protocol message onto standard messaging formats and/or communications protocols.
|
ssoUrl | string Required. Single sign-on endpoint URL. Specify the link to the IdP login page here. The maximum string length in characters is 8000. |
securitySettings | object Federation security settings. Federation security settings. |
securitySettings. encryptedAssertions |
boolean (boolean) Enable encrypted assertions. |
caseInsensitiveNameIds | boolean (boolean) Use case insensitive name ids. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": true,
"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.
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 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. 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 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
done | boolean (boolean) If the value is |
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 | object The error result of the operation in case of failure or cancellation. includes only one of the fields error , response |
error. code |
integer (int32) Error code. An enum value of google.rpc.Code. |
error. message |
string An error message. |
error. details[] |
object A list of messages that carry the error details. |
response | object includes only one of the fields error , response 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. 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. |