Opensearch dashboards.iscopedclusterclient

Home > opensearch-dashboards > IScopedClusterClient

IScopedClusterClient interface

Serves the same purpose as the normal cluster client but exposes an additional asCurrentUser method that doesn't use credentials of the OpenSearch Dashboards internal user (as asInternalUser does) to request OpenSearch API, but rather passes HTTP headers extracted from the current user request to the API instead.

Signature:

export interface IScopedClusterClient 

Properties

Property	Type	Description
asCurrentUser	OpenSearchClient	A client to be used to query the opensearch cluster on behalf of the user that initiated the request to the OpenSearch Dashboards server.
asInternalUser	OpenSearchClient	A client to be used to query the opensearch cluster on behalf of the internal OpenSearch Dashboards user.