Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for OpenSearch API, REST: Cluster.UpdateAuthSettings

Written by
Updated at October 17, 2024

Updates auth settings for specified cluster.

HTTP request

PUT https://mdb.api.cloud.yandex.net/managed-opensearch/v1/clusters/{clusterId}/auth

Path parameters

Field

Description

clusterId

string

Required field. Required. ID of the OpenSearch cluster.

Body parameters

{
  "settings": {
    "saml": {
      "enabled": "boolean",
      "idpEntityId": "string",
      "idpMetadataFile": "string",
      "spEntityId": "string",
      "dashboardsUrl": "string",
      "rolesKey": "string",
      "subjectKey": "string",
      "jwtDefaultExpirationTimeout": "string"
    }
  }
}

Field

Description

settings

AuthSettings

Required. Auth settings.

AuthSettings

Field

Description

saml

SAMLSettings

SAML settings

SAMLSettings

Field

Description

enabled

boolean

idpEntityId

string

Required. The entity ID of your IdP.

idpMetadataFile

string (bytes)

Required. The SAML 2.0 metadata file of your IdP.

spEntityId

string

Required. The entity ID of the service provider.

dashboardsUrl

string

Required. The OpenSearch Dashboards base URL.

rolesKey

string

Optional. The attribute in the SAML response where the roles are stored. If not configured, no roles are used.

subjectKey

string

Optional. The attribute in the SAML response where the subject is stored. If not configured, the NameID attribute is used.

jwtDefaultExpirationTimeout

string (int64)

default jwt expiration timeout.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "saml": {
      "enabled": "boolean",
      "idpEntityId": "string",
      "idpMetadataFile": "string",
      "spEntityId": "string",
      "dashboardsUrl": "string",
      "rolesKey": "string",
      "subjectKey": "string",
      "jwtDefaultExpirationTimeout": "string"
    }
  }
  // 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

UpdateAuthSettingsMetadata

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

AuthSettings

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.

UpdateAuthSettingsMetadata

Field

Description

clusterId

string

ID of the OpenSearch cluster.

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.

AuthSettings

Field

Description

saml

SAMLSettings

SAML settings

SAMLSettings

Field

Description

enabled

boolean

idpEntityId

string

Required. The entity ID of your IdP.

idpMetadataFile

string (bytes)

Required. The SAML 2.0 metadata file of your IdP.

spEntityId

string

Required. The entity ID of the service provider.

dashboardsUrl

string

Required. The OpenSearch Dashboards base URL.

rolesKey

string

Optional. The attribute in the SAML response where the roles are stored. If not configured, no roles are used.

subjectKey

string

Optional. The attribute in the SAML response where the subject is stored. If not configured, the NameID attribute is used.

jwtDefaultExpirationTimeout

string (int64)

default jwt expiration timeout.
Previous
GetAuthSettings
Next
Overview