Coveo Authorization Server API — Users

naftiko: 1.0.0-alpha2
info:
  label: Coveo Authorization Server API — Users
  description: 'Coveo Authorization Server API — Users. 3 operations. Lead operation: Show User. Self-contained Naftiko capability
    covering one Coveo business surface.'
  tags:
  - Coveo
  - Authorization Server
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: authorization-users
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Authorization Server API — Users business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-users-username
      path: /rest/users/{username}
      operations:
      - name: getuser
        method: GET
        description: Show User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: username
          in: path
          type: string
          description: The username of the user to show.</br>**Example:** `[email protected]`
          required: true
      - name: updateuseradditionalinformation
        method: PUT
        description: Update User Additional Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: username
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-users-username-realms
      path: /rest/users/{username}/realms
      operations:
      - name: getallexistingrealmsforuser
        method: GET
        description: List User Realms
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: username
          in: path
          type: string
          description: The username of the user for which to list realms.</br>**Example:** `[email protected]`
          required: true
  exposes:
  - type: rest
    namespace: authorization-users-rest
    port: 8080
    description: REST adapter for Coveo Authorization Server API — Users. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/users/{username}
      name: rest-users-username
      description: REST surface for rest-users-username.
      operations:
      - method: GET
        name: getuser
        description: Show User
        call: authorization-users.getuser
        with:
          username: rest.username
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuseradditionalinformation
        description: Update User Additional Information
        call: authorization-users.updateuseradditionalinformation
        with:
          username: rest.username
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{username}/realms
      name: rest-users-username-realms
      description: REST surface for rest-users-username-realms.
      operations:
      - method: GET
        name: getallexistingrealmsforuser
        description: List User Realms
        call: authorization-users.getallexistingrealmsforuser
        with:
          username: rest.username
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: authorization-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Authorization Server API — Users. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: show-user
      description: Show User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-users.getuser
      with:
        username: tools.username
      outputParameters:
      - type: object
        mapping: $.
    - name: update-user-additional-information
      description: Update User Additional Information
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-users.updateuseradditionalinformation
      with:
        username: tools.username
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-user-realms
      description: List User Realms
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-users.getallexistingrealmsforuser
      with:
        username: tools.username
      outputParameters:
      - type: object
        mapping: $.