UpdateAuthSettings

Updates auth settings for specified cluster.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const AuthSettings = cloudApi.mdb.opensearch_auth.AuthSettings;
const UpdateAuthSettingsRequest =
  cloudApi.mdb.opensearch_cluster_service.UpdateAuthSettingsRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ClusterServiceClient);

  const operation = await client.updateAuthSettings(
    UpdateAuthSettingsRequest.fromPartial({
      clusterId: "clusterId",
      // settings: {
      // saml: {
      // enabled: true,
      // idpEntityId: "idpEntityId",
      // idpMetadataFile: Buffer.from([]),
      // spEntityId: "spEntityId",
      // dashboardsUrl: "dashboardsUrl",
      // rolesKey: "rolesKey",
      // subjectKey: "subjectKey",
      // jwtDefaultExpirationTimeout: {
      // value: 0
      // }
      // }
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof AuthSettings>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.mdb.opensearch.v1.auth_pb2 import AuthSettings
from yandex.cloud.dataproc.v1.cluster_service_pb2_grpc import ClusterServiceStub
from yandex.cloud.mdb.opensearch.v1.auth_pb2 import SAMLSettings
from yandex.cloud.mdb.opensearch.v1.cluster_service_pb2 import UpdateAuthSettingsMetadata
from yandex.cloud.mdb.opensearch.v1.cluster_service_pb2 import UpdateAuthSettingsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ClusterServiceStub)
operation = service.UpdateAuthSettings(
    UpdateAuthSettingsRequest(
        cluster_id="clusterId",
        # settings = AuthSettings(
        # saml = SAMLSettings(
        # enabled = true,
        # idp_entity_id = "idpEntityId",
        # idp_metadata_file = b'',
        # sp_entity_id = "spEntityId",
        # dashboards_url = "dashboardsUrl",
        # roles_key = "rolesKey",
        # subject_key = "subjectKey",
        # jwt_default_expiration_timeout = Int64Value(
        # value = 0
        # )
        # )
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=AuthSettings,
    meta_type=UpdateAuthSettingsMetadata,
)
print(operation_result)

UpdateAuthSettingsRequest

clusterId : string

Required. ID of the OpenSearch cluster.

settings : AuthSettings

Required. Auth settings.

AuthSettings

saml : SAMLSettings

SAML settings

SAMLSettings

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

An Operation resource. For more information, see Operation.

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 : google.protobuf.Any

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.

One of result

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.

• error : google.rpc.Status

  The error result of the operation in case of failure or cancellation.

• response : google.protobuf.Any

  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.

---