OpenSearch

OpenSearch Roles API

CRUD for security roles and their permissions.

GitHub OpenAPI

Operations 5

GET /_plugins/_security/api/roles List all roles #
GET /_plugins/_security/api/roles/{name} Get role #
PUT /_plugins/_security/api/roles/{name} Create or replace a role #
DELETE /_plugins/_security/api/roles/{name} Delete role #
PATCH /_plugins/_security/api/roles/{name} Patch role #

Documentation

📖
Documentation
https://docs.opensearch.org/latest/security/access-control/api/
📖
Documentation
https://docs.opensearch.org/latest/security/access-control/index/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/openapi/opensearch-roles-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-schema/opensearch-role-schema.json

Other Resources

🔗
JSONLDContext
https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/json-ld/opensearch-context.jsonld
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/opensearch/refs/heads/main/graphql/opensearch-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/opensearch-roles-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

opensearch-roles-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenSearch Security Plugin REST Account Roles 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: Roles
  description: CRUD for security roles and their permissions.
paths:
  /_plugins/_security/api/roles:
    get:
      operationId: listRoles
      summary: List all roles
      tags:
      - Roles
      responses:
        '200':
          description: All roles.
  /_plugins/_security/api/roles/{name}:
    parameters:
    - name: name
      in: path
      required: true
      schema:
        type: string
    get:
      operationId: getRole
      summary: Get role
      tags:
      - Roles
      responses:
        '200':
          description: Role definition.
    put:
      operationId: createOrReplaceRole
      summary: Create or replace a role
      tags:
      - Roles
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Role'
      responses:
        '200':
          description: Role created or updated.
    delete:
      operationId: deleteRole
      summary: Delete role
      tags:
      - Roles
      responses:
        '200':
          description: Role deleted.
    patch:
      operationId: patchRole
      summary: Patch role
      tags:
      - Roles
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
      responses:
        '200':
          description: Role patched.
components:
  schemas:
    Role:
      type: object
      properties:
        cluster_permissions:
          type: array
          items:
            type: string
        index_permissions:
          type: array
          items:
            type: object
            properties:
              index_patterns:
                type: array
                items:
                  type: string
              dls:
                type: string
              fls:
                type: array
                items:
                  type: string
              masked_fields:
                type: array
                items:
                  type: string
              allowed_actions:
                type: array
                items:
                  type: string
        tenant_permissions:
          type: array
          items:
            type: object
            properties:
              tenant_patterns:
                type: array
                items:
                  type: string
              allowed_actions:
                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/