Oracle Essbase REST API — Users

naftiko: 1.0.0-alpha2
info:
  label: Oracle Essbase REST API — Users
  description: 'Oracle Essbase REST API — Users. 5 operations. Lead operation: Oracle Essbase List Users. Self-contained Naftiko
    capability covering one Oracle Essbase business surface.'
  tags:
  - Oracle Essbase
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_ESSBASE_API_KEY: ORACLE_ESSBASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-users
    baseUri: https://{host}:{port}/essbase/rest/v1
    description: Oracle Essbase REST API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: listusers
        method: GET
        description: Oracle Essbase List Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: expand
          in: query
          type: string
          description: Include service role and groups. Values are all or none.
        - name: filter
          in: query
          type: string
          description: User ID wildcard pattern for filtering.
        - name: limit
          in: query
          type: integer
          description: Maximum number of users to return. -1 for no limit.
      - name: createuser
        method: POST
        description: Oracle Essbase Create User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-userId
      path: /users/{userId}
      operations:
      - name: getuser
        method: GET
        description: Oracle Essbase Get User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: User identifier.
          required: true
      - name: updateuser
        method: PUT
        description: Oracle Essbase Update User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: User identifier.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteuser
        method: DELETE
        description: Oracle Essbase Delete User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: userId
          in: path
          type: string
          description: User identifier.
          required: true
    authentication:
      type: bearer
      token: '{{env.ORACLE_ESSBASE_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-users-rest
    port: 8080
    description: REST adapter for Oracle Essbase REST API — Users. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/users
      name: users
      description: REST surface for users.
      operations:
      - method: GET
        name: listusers
        description: Oracle Essbase List Users
        call: rest-users.listusers
        with:
          expand: rest.expand
          filter: rest.filter
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Oracle Essbase Create User
        call: rest-users.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}
      name: users-userid
      description: REST surface for users-userId.
      operations:
      - method: GET
        name: getuser
        description: Oracle Essbase Get User
        call: rest-users.getuser
        with:
          userId: rest.userId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuser
        description: Oracle Essbase Update User
        call: rest-users.updateuser
        with:
          userId: rest.userId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: Oracle Essbase Delete User
        call: rest-users.deleteuser
        with:
          userId: rest.userId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle Essbase REST API — Users. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: oracle-essbase-list-users
      description: Oracle Essbase List Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-users.listusers
      with:
        expand: tools.expand
        filter: tools.filter
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-create-user
      description: Oracle Essbase Create User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-users.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-get-user
      description: Oracle Essbase Get User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-users.getuser
      with:
        userId: tools.userId
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-update-user
      description: Oracle Essbase Update User
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-users.updateuser
      with:
        userId: tools.userId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-essbase-delete-user
      description: Oracle Essbase Delete User
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-users.deleteuser
      with:
        userId: tools.userId
      outputParameters:
      - type: object
        mapping: $.