openapi: 3.1.0
info:
  title: OpenSearch Security Plugin REST Account Audit 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: Audit
  description: Audit log configuration.
paths:
  /_plugins/_security/api/audit:
    get:
      operationId: getAuditConfig
      summary: Get audit log configuration
      tags:
      - Audit
      responses:
        '200':
          description: Audit log configuration.
  /_plugins/_security/api/audit/config:
    put:
      operationId: replaceAuditConfig
      summary: Replace audit log configuration
      tags:
      - Audit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Audit configuration replaced.
    patch:
      operationId: patchAuditConfig
      summary: Patch audit log configuration
      tags:
      - Audit
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
      responses:
        '200':
          description: Audit configuration patched.
components:
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
externalDocs:
  description: OpenSearch Security Access Control API
  url: https://docs.opensearch.org/latest/security/access-control/api/