Skip to content

Opensearch dashboards.legacyscopedclusterclient.callasinternaluser

Home > opensearch-dashboards > LegacyScopedClusterClient > callAsInternalUser

LegacyScopedClusterClient.callAsInternalUser() method

Calls specified endpoint with provided clientParams on behalf of the OpenSearch Dashboards internal user. See LegacyAPICaller.

Signature:

callAsInternalUser(endpoint: string, clientParams?: Record<string, any>, options?: LegacyCallAPIOptions): Promise<any>;

Parameters

Parameter Type Description
endpoint string String descriptor of the endpoint e.g. cluster.getSettings or ping.
clientParams Record<string, any> A dictionary of parameters that will be passed directly to the OpenSearch JS client.
options LegacyCallAPIOptions Options that affect the way we call the API and process the result.

Returns:

Promise<any>