openapi: 3.1.0
info:
  title: OpenSearch Security Plugin REST Account Tenants API
  description: The OpenSearch Security plugin REST API lets administrators programmatically create and manage internal users, roles, role mappings, action groups, tenants, security configuration, audit log configuration, certificates, cache, allowlists, distinguished node names, and inspect the running security configuration. Endpoints are exposed under /_plugins/_security/api on the OpenSearch cluster.
  version: 2.x
  contact:
    name: OpenSearch Project
    url: https://opensearch.org/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://{cluster-host}:9200
  description: OpenSearch cluster (default port 9200)
  variables:
    cluster-host:
      default: localhost
security:
- BasicAuth: []
tags:
- name: Tenants
  description: Multi-tenancy support for OpenSearch Dashboards.
paths:
  /_plugins/_security/api/tenants:
    get:
      operationId: listTenants
      summary: List all tenants
      tags:
      - Tenants
      responses:
        '200':
          description: All tenants.
  /_plugins/_security/api/tenants/{name}:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getTenant
      summary: Get tenant
      tags:
      - Tenants
      responses:
        '200':
          description: Tenant definition.
    put:
      operationId: createOrReplaceTenant
      summary: Create or replace a tenant
      tags:
      - Tenants
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Tenant'
      responses:
        '200':
          description: Tenant created or updated.
    delete:
      operationId: deleteTenant
      summary: Delete tenant
      tags:
      - Tenants
      responses:
        '200':
          description: Tenant deleted.
    patch:
      operationId: patchTenant
      summary: Patch tenant
      tags:
      - Tenants
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
      responses:
        '200':
          description: Tenant patched.
components:
  schemas:
    Tenant:
      type: object
      properties:
        description:
          type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
externalDocs:
  description: OpenSearch Security Access Control API
  url: https://docs.opensearch.org/latest/security/access-control/api/