Contact UsGet started

Managed Service for OpenSearch API, gRPC: ClusterService.UpdateAuthSettings

Written by
Updated at October 17, 2024

Updates auth settings for specified cluster.

gRPC request

rpc UpdateAuthSettings (UpdateAuthSettingsRequest) returns (operation.Operation)

UpdateAuthSettingsRequest

{
  "clusterId": "string",
  "settings": {
    "saml": {
      "enabled": "bool",
      "idpEntityId": "string",
      "idpMetadataFile": "bytes",
      "spEntityId": "string",
      "dashboardsUrl": "string",
      "rolesKey": "string",
      "subjectKey": "string",
      "jwtDefaultExpirationTimeout": "google.protobuf.Int64Value"
    }
  }
}

Field

Description

clusterId

string

Required field. Required. ID of the OpenSearch cluster.

settings

AuthSettings

Required. Auth settings.

AuthSettings

Field

Description

saml

SAMLSettings

SAML settings

SAMLSettings

Field

Description

enabled

bool

idpEntityId

string

Required. The entity ID of your IdP.

idpMetadataFile

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

google.protobuf.Int64Value

default jwt expiration timeout.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "clusterId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "saml": {
      "enabled": "bool",
      "idpEntityId": "string",
      "idpMetadataFile": "bytes",
      "spEntityId": "string",
      "dashboardsUrl": "string",
      "rolesKey": "string",
      "subjectKey": "string",
      "jwtDefaultExpirationTimeout": "google.protobuf.Int64Value"
    }
  }
  // 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

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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

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

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.

AuthSettings

Field

Description

saml

SAMLSettings

SAML settings

SAMLSettings

Field

Description

enabled

bool

idpEntityId

string

Required. The entity ID of your IdP.

idpMetadataFile

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

google.protobuf.Int64Value

default jwt expiration timeout.
Previous
GetAuthSettings
Next
Overview