Link Search Menu Expand Document Documentation Menu

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.

Field Data type Description Required
description String A description of the tenant. No

Example request

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

Example response

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

Have a question? .

Want to contribute? or .