Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Identity and Access Management SAML API, REST: Federation.Update

Written by
Updated at December 17, 2024

Updates the specified federation.

HTTP request

PATCH https://iam.api.cloud.yandex.net/iam/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 request.

Body parameters

{
  "updateMask": "object",
  "name": "string",
  "description": "string",
  "cookieMaxAge": "string",
  "autoCreateAccountOnLogin": "boolean",
  "issuer": "string",
  "ssoBinding": "string",
  "ssoUrl": "string",
  "securitySettings": {
    "encryptedAssertions": "boolean"
  },
  "caseInsensitiveNameIds": "boolean"
}

Field

Description

updateMask

object (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 cloud.

description

string

Description of the federation.

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 will get the resource-manager.clouds.member role automatically,
but you need to grant other roles to them.

If the value is false, users who aren't added to the cloud
can't log in, even if they have authenticated on your server.

issuer

string

Required field. ID of the IdP server to be used for authentication.
The IdP server also responds to IAM with this ID after the user authenticates.

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.

  • BINDING_TYPE_UNSPECIFIED
  • POST: HTTP POST binding.
  • REDIRECT: HTTP redirect binding.
  • ARTIFACT: HTTP artifact binding.

ssoUrl

string

Required field. Single sign-on endpoint URL.
Specify the link to the IdP login page here.

securitySettings

FederationSecuritySettings

Federation security settings.

caseInsensitiveNameIds

boolean

Use case insensitive name ids.

FederationSecuritySettings

Federation security settings.

Field

Description

encryptedAssertions

boolean

Enable encrypted assertions.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "federationId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "name": "string",
    "description": "string",
    "createdAt": "string",
    "cookieMaxAge": "string",
    "autoCreateAccountOnLogin": "boolean",
    "issuer": "string",
    "ssoBinding": "string",
    "ssoUrl": "string",
    "securitySettings": {
      "encryptedAssertions": "boolean"
    },
    "caseInsensitiveNameIds": "boolean"
  }
  // 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
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.
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
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.
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

UpdateFederationMetadata

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

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

Federation

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.

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.

UpdateFederationMetadata

Field

Description

federationId

string

ID of the federation that is being updated.

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.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

Federation

A federation.
For more information, see SAML-compatible identity federations.

Field

Description

id

string

Required field. ID of the federation.

folderId

string

Required field. ID of the folder that the federation belongs to.

name

string

Required field. Name of the federation.

description

string

Description of the federation.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 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.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

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.

autoCreateAccountOnLogin

boolean

Add new users automatically on successful authentication.
The user will get the resource-manager.clouds.member role automatically,
but you need to grant other roles to them.

If the value is false, users who aren't added to the cloud
can't log in, even if they have authenticated on your server.

issuer

string

Required field. ID of the IdP server to be used for authentication.
The IdP server also responds to IAM with this ID after the user authenticates.

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.

  • BINDING_TYPE_UNSPECIFIED
  • POST: HTTP POST binding.
  • REDIRECT: HTTP redirect binding.
  • ARTIFACT: HTTP artifact binding.

ssoUrl

string

Required field. Single sign-on endpoint URL.
Specify the link to the IdP login page here.

securitySettings

FederationSecuritySettings

Federation security settings.

caseInsensitiveNameIds

boolean

Use case insensitive Name IDs.

FederationSecuritySettings

Federation security settings.

Field

Description

encryptedAssertions

boolean

Enable encrypted assertions.
Previous
Create
Next
Delete