OpenSearch Security Plugin REST API — Internal Users

naftiko: 1.0.0-alpha2
info:
  label: OpenSearch Security Plugin REST API — Internal Users
  description: 'OpenSearch Security Plugin REST API — Internal Users. 5 operations. Lead operation: List all internal users.
    Self-contained Naftiko capability covering one Opensearch business surface.'
  tags:
  - Opensearch
  - Internal Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    OPENSEARCH_API_KEY: OPENSEARCH_API_KEY
capability:
  consumes:
  - type: http
    namespace: security-internal-users
    baseUri: https://{cluster-host}:9200
    description: OpenSearch Security Plugin REST API — Internal Users business capability. Self-contained, no shared references.
    resources:
    - name: _plugins-_security-api-internalusers
      path: /_plugins/_security/api/internalusers
      operations:
      - name: listinternalusers
        method: GET
        description: List all internal users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: _plugins-_security-api-internalusers-username
      path: /_plugins/_security/api/internalusers/{username}
      operations:
      - name: getinternaluser
        method: GET
        description: Get internal user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createorreplaceinternaluser
        method: PUT
        description: Create or replace an internal user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteinternaluser
        method: DELETE
        description: Delete internal user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchinternaluser
        method: PATCH
        description: Patch internal user
        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-internal-users-rest
    port: 8080
    description: REST adapter for OpenSearch Security Plugin REST API — Internal Users. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/plugins/security/api/internalusers
      name: plugins-security-api-internalusers
      description: REST surface for _plugins-_security-api-internalusers.
      operations:
      - method: GET
        name: listinternalusers
        description: List all internal users
        call: security-internal-users.listinternalusers
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/plugins/security/api/internalusers/{username}
      name: plugins-security-api-internalusers-username
      description: REST surface for _plugins-_security-api-internalusers-username.
      operations:
      - method: GET
        name: getinternaluser
        description: Get internal user
        call: security-internal-users.getinternaluser
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: createorreplaceinternaluser
        description: Create or replace an internal user
        call: security-internal-users.createorreplaceinternaluser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteinternaluser
        description: Delete internal user
        call: security-internal-users.deleteinternaluser
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchinternaluser
        description: Patch internal user
        call: security-internal-users.patchinternaluser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: security-internal-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenSearch Security Plugin REST API — Internal Users. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-all-internal-users
      description: List all internal users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: security-internal-users.listinternalusers
      outputParameters:
      - type: object
        mapping: $.
    - name: get-internal-user
      description: Get internal user
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: security-internal-users.getinternaluser
      outputParameters:
      - type: object
        mapping: $.
    - name: create-replace-internal-user
      description: Create or replace an internal user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: security-internal-users.createorreplaceinternaluser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-internal-user
      description: Delete internal user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: security-internal-users.deleteinternaluser
      outputParameters:
      - type: object
        mapping: $.
    - name: patch-internal-user
      description: Patch internal user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: security-internal-users.patchinternaluser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.