Skip to main content

ListProviders

Retrieves the list of registered auth providers for Elasticsearch cluster.

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

const ListAuthProvidersRequest =
cloudApi.mdb.elasticsearch_auth_service.ListAuthProvidersRequest;

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

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

ListAuthProvidersRequest

clusterId : string

Required. ID of the ElasticSearch cluster.

ListAuthProvidersResponse

providers : AuthProvider

List of auth providers of the Elasticsearch cluster.

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