openapi: 3.1.0
info:
  title: OpenSearch Security Plugin REST Account Internal Users 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: Internal Users
  description: CRUD for internal user database entries.
paths:
  /_plugins/_security/api/internalusers:
    get:
      operationId: listInternalUsers
      summary: List all internal users
      tags:
      - Internal Users
      responses:
        '200':
          description: Map of all internal users.
  /_plugins/_security/api/internalusers/{username}:
    parameters:
    - name: username
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getInternalUser
      summary: Get internal user
      tags:
      - Internal Users
      responses:
        '200':
          description: Internal user definition.
    put:
      operationId: createOrReplaceInternalUser
      summary: Create or replace an internal user
      tags:
      - Internal Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InternalUser'
      responses:
        '200':
          description: User created or updated.
    delete:
      operationId: deleteInternalUser
      summary: Delete internal user
      tags:
      - Internal Users
      responses:
        '200':
          description: User deleted.
    patch:
      operationId: patchInternalUser
      summary: Patch internal user
      tags:
      - Internal Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
      responses:
        '200':
          description: User patched.
components:
  schemas:
    InternalUser:
      type: object
      properties:
        password:
          type: string
        hash:
          type: string
        backend_roles:
          type: array
          items:
            type: string
        attributes:
          type: object
          additionalProperties:
            type: string
        opendistro_security_roles:
          type: array
          items:
            type: string
        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/