AddProviders

Adds new auth providers to Elasticsearch cluster.

TypeScript

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

const AddAuthProvidersRequest =
  cloudApi.mdb.elasticsearch_auth_service.AddAuthProvidersRequest;
const AuthProvider_Type = cloudApi.mdb.elasticsearch_auth.AuthProvider_Type;
const AuthProviders = cloudApi.mdb.elasticsearch_auth.AuthProviders;

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

  const operation = await client.addProviders(
    AddAuthProvidersRequest.fromPartial({
      clusterId: "clusterId",
      // providers: [{
      // type: AuthProvider_Type.NATIVE,
      // name: "name",
      // order: 0,
      // enabled: true,
      // hidden: true,
      // description: "description",
      // hint: "hint",
      // icon: "icon",
      // saml: {
      // idpEntityId: "idpEntityId",
      // idpMetadataFile: Buffer.from([]),
      // spEntityId: "spEntityId",
      // kibanaUrl: "kibanaUrl",
      // attributePrincipal: "attributePrincipal",
      // attributeGroups: "attributeGroups",
      // attributeName: "attributeName",
      // attributeEmail: "attributeEmail",
      // attributeDn: "attributeDn"
      // }
      // }]
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.mdb.elasticsearch.v1.auth_service_pb2 import AddAuthProvidersMetadata
from yandex.cloud.mdb.elasticsearch.v1.auth_service_pb2 import AddAuthProvidersRequest
from yandex.cloud.mdb.elasticsearch.v1.auth_pb2 import AuthProvider
from yandex.cloud.mdb.elasticsearch.v1.auth_pb2 import AuthProviders
from yandex.cloud.mdb.elasticsearch.v1.auth_service_pb2_grpc import AuthServiceStub
from yandex.cloud.mdb.elasticsearch.v1.auth_pb2 import SamlSettings

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(AuthServiceStub)
operation = service.AddProviders(
    AddAuthProvidersRequest(
        cluster_id="clusterId",
        # providers = [AuthProvider(
        # type = AuthProvider.Type.NATIVE,
        # name = "name",
        # order = 0,
        # enabled = true,
        # hidden = true,
        # description = "description",
        # hint = "hint",
        # icon = "icon",
        # saml = SamlSettings(
        # idp_entity_id = "idpEntityId",
        # idp_metadata_file = b'',
        # sp_entity_id = "spEntityId",
        # kibana_url = "kibanaUrl",
        # attribute_principal = "attributePrincipal",
        # attribute_groups = "attributeGroups",
        # attribute_name = "attributeName",
        # attribute_email = "attributeEmail",
        # attribute_dn = "attributeDn"
        # )
        # )]
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=AuthProviders,
    meta_type=AddAuthProvidersMetadata,
)
print(operation_result)

AddAuthProvidersRequest

clusterId : string

Required. ID of the ElasticSearch cluster.

providers : AuthProvider

Required. List of providers to add.

AuthProvider

Type

• TYPE_UNSPECIFIED

• NATIVE

• SAML

type : Type

name : string

order : int64

enabled : bool

hidden : bool

selector ui settings

description : string

hint : string

icon : string

One of settings

• saml : SamlSettings

SamlSettings

idpEntityId : string

idpMetadataFile : bytes

spEntityId : string

kibanaUrl : string

attributePrincipal : string

attributeGroups : string

attributeName : string

attributeEmail : string

attributeDn : string

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.

---