You're viewing version 3.8 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Tenant Info API

Introduced 1.0

Retrieves the index names that back the current tenants.

This API is reserved for a superadmin or the kibanaserver user. Authenticate with an admin certificate rather than with a user name and password. For more information, see Access control for the API.

Endpoints

GET  /_plugins/_security/tenantinfo
POST /_plugins/_security/tenantinfo

Example request

GET _plugins/_security/tenantinfo

Example response

The response maps each tenant index to the tenant it belongs to. It is empty until a tenant index is created:

{}