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.

Create or Update Tenant API

Introduced 1.0

Creates or replaces the specified tenant.

Endpoints

PUT /_plugins/_security/api/tenants/{tenant}

Request body fields

The request body is required. It is a JSON object with the following field.

Example request

PUT _plugins/_security/api/tenants/test-tenant
{
  "description": "A tenant for the test team."
}

Example response

{
  "status": "CREATED",
  "message": "'test-tenant' created."
}