Coveo Authorization Server API — Group Members

naftiko: 1.0.0-alpha2
info:
  label: Coveo Authorization Server API — Group Members
  description: 'Coveo Authorization Server API — Group Members. 4 operations. Lead operation: List Group Members. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Authorization Server
  - Group 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-group-members
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Authorization Server API — Group Members business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-groups-groupId-members
      path: /rest/organizations/{organizationId}/groups/{groupId}/members
      operations:
      - name: getgroupmembers
        method: GET
        description: List Group 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: groupId
          in: path
          type: string
          description: The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`
          required: true
      - name: addgroupmember
        method: POST
        description: Add 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: groupId
          in: path
          type: string
          description: The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`
          required: true
        - name: sendEmailOnInvite
          in: query
          type: boolean
          description: Whether to send an email alongside the invite.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-groups-groupId-members-username
      path: /rest/organizations/{organizationId}/groups/{groupId}/members/{username}
      operations:
      - name: getgroupmember
        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: groupId
          in: path
          type: string
          description: The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`
          required: true
        - name: username
          in: path
          type: string
          description: The username of the [member](https://docs.coveo.com/en/2873/) to show.</br>**Example:** `[email protected]`
          required: true
      - name: deletegroupmember
        method: DELETE
        description: Delete 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: username
          in: path
          type: string
          description: The username of the [member](https://docs.coveo.com/en/2873/) to delete.</br>**Example:** `[email protected]`
          required: true
        - name: groupId
          in: path
          type: string
          description: The unique identifier of the target [group](https://docs.coveo.com/en/2867/).</br>**Example:**`myorganization-bfghkjfjb674jh5egjk`
          required: true
  exposes:
  - type: rest
    namespace: authorization-group-members-rest
    port: 8080
    description: REST adapter for Coveo Authorization Server API — Group Members. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/groups/{groupid}/members
      name: rest-organizations-organizationid-groups-groupid-members
      description: REST surface for rest-organizations-organizationId-groups-groupId-members.
      operations:
      - method: GET
        name: getgroupmembers
        description: List Group Members
        call: authorization-group-members.getgroupmembers
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addgroupmember
        description: Add User
        call: authorization-group-members.addgroupmember
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
          sendEmailOnInvite: rest.sendEmailOnInvite
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/groups/{groupid}/members/{username}
      name: rest-organizations-organizationid-groups-groupid-members-username
      description: REST surface for rest-organizations-organizationId-groups-groupId-members-username.
      operations:
      - method: GET
        name: getgroupmember
        description: Show Member
        call: authorization-group-members.getgroupmember
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
          username: rest.username
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegroupmember
        description: Delete User
        call: authorization-group-members.deletegroupmember
        with:
          organizationId: rest.organizationId
          username: rest.username
          groupId: rest.groupId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: authorization-group-members-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Authorization Server API — Group Members. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-group-members
      description: List Group Members
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-group-members.getgroupmembers
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
      outputParameters:
      - type: object
        mapping: $.
    - name: add-user
      description: Add User
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: authorization-group-members.addgroupmember
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
        sendEmailOnInvite: tools.sendEmailOnInvite
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: show-member
      description: Show Member
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-group-members.getgroupmember
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
        username: tools.username
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user
      description: Delete User
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: authorization-group-members.deletegroupmember
      with:
        organizationId: tools.organizationId
        username: tools.username
        groupId: tools.groupId
      outputParameters:
      - type: object
        mapping: $.