Coveo Authorization Server API — Organization Members

naftiko: 1.0.0-alpha2
info:
  label: Coveo Authorization Server API — Organization Members
  description: 'Coveo Authorization Server API — Organization Members. 7 operations. Lead operation: List Members. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Authorization Server
  - Organization Members
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: authorization-organization-members
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Authorization Server API — Organization Members business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-members
      path: /rest/organizations/{organizationId}/members
      operations:
      - name: getorganizationmembers
        method: GET
        description: List Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
      - name: updateorganizationmembers
        method: PUT
        description: Update Organization Members
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: sendEmailToInvitedUsers
          in: query
          type: boolean
          description: Whether to send an invitation email alongside the invite(s).</br>**Default:** `true`
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-members-privileges
      path: /rest/organizations/{organizationId}/members/privileges
      operations:
      - name: getorganizationmemberprivileges2
        method: GET
        description: List Privileges of Current User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
    - name: rest-organizations-organizationId-members-username
      path: /rest/organizations/{organizationId}/members/{username}
      operations:
      - name: getorganizationmember
        method: GET
        description: Show Member
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: username
          in: path
          type: string
          description: The username of the member to show.</br>**Example:** `[email protected]`
          required: true
      - name: updateorganizationmember
        method: PUT
        description: Update Member
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: username
          in: path
          type: string
          description: The username of the member to update.</br>**Example:** `[email protected]`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteorganizationmember
        method: DELETE
        description: Delete Member
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: username
          in: path
          type: string
          description: The username of the member to delete.</br>**Example:** `[email protected]`
          required: true
    - name: rest-organizations-organizationId-members-username-groups
      path: /rest/organizations/{organizationId}/members/{username}/groups
      operations:
      - name: getmembergroups
        method: GET
        description: List Groups for Organization Member
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the target [organization](https://docs.coveo.com/en/185/).<br />**Example:**
            `mycoveocloudv2organizationg8tp8wu3`
          required: true
        - name: username
          in: path
          type: string
          description: The username of the user for which to list groups.</br>**Example:** `[email protected]`
          required: true
  exposes:
  - type: rest
    namespace: authorization-organization-members-rest
    port: 8080
    description: REST adapter for Coveo Authorization Server API — Organization Members. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/members
      name: rest-organizations-organizationid-members
      description: REST surface for rest-organizations-organizationId-members.
      operations:
      - method: GET
        name: getorganizationmembers
        description: List Members
        call: authorization-organization-members.getorganizationmembers
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateorganizationmembers
        description: Update Organization Members
        call: authorization-organization-members.updateorganizationmembers
        with:
          organizationId: rest.organizationId
          sendEmailToInvitedUsers: rest.sendEmailToInvitedUsers
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/members/privileges
      name: rest-organizations-organizationid-members-privileges
      description: REST surface for rest-organizations-organizationId-members-privileges.
      operations:
      - method: GET
        name: getorganizationmemberprivileges2
        description: List Privileges of Current User
        call: authorization-organization-members.getorganizationmemberprivileges2
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/members/{username}
      name: rest-organizations-organizationid-members-username
      description: REST surface for rest-organizations-organizationId-members-username.
      operations:
      - method: GET
        name: getorganizationmember
        description: Show Member
        call: authorization-organization-members.getorganizationmember
        with:
          organizationId: rest.organizationId
          username: rest.username
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateorganizationmember
        description: Update Member
        call: authorization-organization-members.updateorganizationmember
        with:
          organizationId: rest.organizationId
          username: rest.username
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteorganizationmember
        description: Delete Member
        call: authorization-organization-members.deleteorganizationmember
        with:
          organizationId: rest.organizationId
          username: rest.username
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/members/{username}/groups
      name: rest-organizations-organizationid-members-username-groups
      description: REST surface for rest-organizations-organizationId-members-username-groups.
      operations:
      - method: GET
        name: getmembergroups
        description: List Groups for Organization Member
        call: authorization-organization-members.getmembergroups
        with:
          organizationId: rest.organizationId
          username: rest.username
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: authorization-organization-members-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Authorization Server API — Organization Members. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-members
      description: List Members
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-organization-members.getorganizationmembers
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-organization-members
      description: Update Organization Members
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-organization-members.updateorganizationmembers
      with:
        organizationId: tools.organizationId
        sendEmailToInvitedUsers: tools.sendEmailToInvitedUsers
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-privileges-current-user
      description: List Privileges of Current User
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-organization-members.getorganizationmemberprivileges2
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: show-member
      description: Show Member
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-organization-members.getorganizationmember
      with:
        organizationId: tools.organizationId
        username: tools.username
      outputParameters:
      - type: object
        mapping: $.
    - name: update-member
      description: Update Member
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-organization-members.updateorganizationmember
      with:
        organizationId: tools.organizationId
        username: tools.username
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-member
      description: Delete Member
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: authorization-organization-members.deleteorganizationmember
      with:
        organizationId: tools.organizationId
        username: tools.username
      outputParameters:
      - type: object
        mapping: $.
    - name: list-groups-organization-member
      description: List Groups for Organization Member
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-organization-members.getmembergroups
      with:
        organizationId: tools.organizationId
        username: tools.username
      outputParameters:
      - type: object
        mapping: $.