OpenSearch Security Plugin REST API — Role Mappings

naftiko: 1.0.0-alpha2
info:
  label: OpenSearch Security Plugin REST API — Role Mappings
  description: 'OpenSearch Security Plugin REST API — Role Mappings. 5 operations. Lead operation: List all role mappings.
    Self-contained Naftiko capability covering one Opensearch business surface.'
  tags:
  - Opensearch
  - Role Mappings
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENSEARCH_API_KEY: OPENSEARCH_API_KEY
capability:
  consumes:
  - type: http
    namespace: security-role-mappings
    baseUri: https://{cluster-host}:9200
    description: OpenSearch Security Plugin REST API — Role Mappings business capability. Self-contained, no shared references.
    resources:
    - name: _plugins-_security-api-rolesmapping
      path: /_plugins/_security/api/rolesmapping
      operations:
      - name: listrolemappings
        method: GET
        description: List all role mappings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: _plugins-_security-api-rolesmapping-name
      path: /_plugins/_security/api/rolesmapping/{name}
      operations:
      - name: getrolemapping
        method: GET
        description: Get role mapping
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createorreplacerolemapping
        method: PUT
        description: Create or replace a role mapping
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleterolemapping
        method: DELETE
        description: Delete role mapping
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchrolemapping
        method: PATCH
        description: Patch role mapping
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.OPENSEARCH_USER}}'
      password: '{{env.OPENSEARCH_PASS}}'
  exposes:
  - type: rest
    namespace: security-role-mappings-rest
    port: 8080
    description: REST adapter for OpenSearch Security Plugin REST API — Role Mappings. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/plugins/security/api/rolesmapping
      name: plugins-security-api-rolesmapping
      description: REST surface for _plugins-_security-api-rolesmapping.
      operations:
      - method: GET
        name: listrolemappings
        description: List all role mappings
        call: security-role-mappings.listrolemappings
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/plugins/security/api/rolesmapping/{name}
      name: plugins-security-api-rolesmapping-name
      description: REST surface for _plugins-_security-api-rolesmapping-name.
      operations:
      - method: GET
        name: getrolemapping
        description: Get role mapping
        call: security-role-mappings.getrolemapping
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: createorreplacerolemapping
        description: Create or replace a role mapping
        call: security-role-mappings.createorreplacerolemapping
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterolemapping
        description: Delete role mapping
        call: security-role-mappings.deleterolemapping
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchrolemapping
        description: Patch role mapping
        call: security-role-mappings.patchrolemapping
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: security-role-mappings-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenSearch Security Plugin REST API — Role Mappings. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-all-role-mappings
      description: List all role mappings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: security-role-mappings.listrolemappings
      outputParameters:
      - type: object
        mapping: $.
    - name: get-role-mapping
      description: Get role mapping
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: security-role-mappings.getrolemapping
      outputParameters:
      - type: object
        mapping: $.
    - name: create-replace-role-mapping
      description: Create or replace a role mapping
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: security-role-mappings.createorreplacerolemapping
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-role-mapping
      description: Delete role mapping
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: security-role-mappings.deleterolemapping
      outputParameters:
      - type: object
        mapping: $.
    - name: patch-role-mapping
      description: Patch role mapping
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: security-role-mappings.patchrolemapping
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.