GetAuthSettings

Retrieves auth settings for specified cluster.

TypeScript

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

const GetAuthSettingsRequest =
  cloudApi.mdb.opensearch_cluster_service.GetAuthSettingsRequest;

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

  const result = await client.getAuthSettings(
    GetAuthSettingsRequest.fromPartial({
      clusterId: "clusterId",
    })
  );
  console.log(result);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.dataproc.v1.cluster_service_pb2_grpc import ClusterServiceStub
from yandex.cloud.mdb.opensearch.v1.cluster_service_pb2 import GetAuthSettingsRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ClusterServiceStub)
response = service.GetAuthSettings(GetAuthSettingsRequest(cluster_id="clusterId"))
print(response)

GetAuthSettingsRequest

clusterId : string

Required. ID of the OpenSearch cluster.

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.

---