Coveo Authorization Server API — Group Invites

naftiko: 1.0.0-alpha2
info:
  label: Coveo Authorization Server API — Group Invites
  description: 'Coveo Authorization Server API — Group Invites. 5 operations. Lead operation: List Invites. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Authorization Server
  - Group Invites
  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-invites
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Authorization Server API — Group Invites business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-groups-groupId-invites
      path: /rest/organizations/{organizationId}/groups/{groupId}/invites
      operations:
      - name: getinvites
        method: GET
        description: List Invites
        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: invitemember
        method: POST
        description: Invite User to Group
        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: sendEmail
          in: query
          type: boolean
          description: Whether to send an invitation email alongside the invite.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-groups-groupId-invites-accept
      path: /rest/organizations/{organizationId}/groups/{groupId}/invites/accept
      operations:
      - name: acceptinvite
        method: POST
        description: Accept Invite to Group
        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: invite_code
          in: cookie
          type: string
    - name: rest-organizations-organizationId-groups-groupId-invites-decline
      path: /rest/organizations/{organizationId}/groups/{groupId}/invites/decline
      operations:
      - name: declineinvite
        method: POST
        description: Decline Invite to Group
        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: invite_code
          in: cookie
          type: string
    - name: rest-organizations-organizationId-groups-groupId-invites-usernameOrEmail
      path: /rest/organizations/{organizationId}/groups/{groupId}/invites/{usernameOrEmail}
      operations:
      - name: deleteinvite
        method: DELETE
        description: Delete Invite to Group
        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: usernameOrEmail
          in: path
          type: string
          description: The username or email of the invited user.</br>**Example:** `[email protected]`
          required: true
  exposes:
  - type: rest
    namespace: authorization-group-invites-rest
    port: 8080
    description: REST adapter for Coveo Authorization Server API — Group Invites. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/groups/{groupid}/invites
      name: rest-organizations-organizationid-groups-groupid-invites
      description: REST surface for rest-organizations-organizationId-groups-groupId-invites.
      operations:
      - method: GET
        name: getinvites
        description: List Invites
        call: authorization-group-invites.getinvites
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: invitemember
        description: Invite User to Group
        call: authorization-group-invites.invitemember
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
          sendEmail: rest.sendEmail
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/groups/{groupid}/invites/accept
      name: rest-organizations-organizationid-groups-groupid-invites-accept
      description: REST surface for rest-organizations-organizationId-groups-groupId-invites-accept.
      operations:
      - method: POST
        name: acceptinvite
        description: Accept Invite to Group
        call: authorization-group-invites.acceptinvite
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
          invite_code: rest.invite_code
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/groups/{groupid}/invites/decline
      name: rest-organizations-organizationid-groups-groupid-invites-decline
      description: REST surface for rest-organizations-organizationId-groups-groupId-invites-decline.
      operations:
      - method: POST
        name: declineinvite
        description: Decline Invite to Group
        call: authorization-group-invites.declineinvite
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
          invite_code: rest.invite_code
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/groups/{groupid}/invites/{usernameoremail}
      name: rest-organizations-organizationid-groups-groupid-invites-usernameoremail
      description: REST surface for rest-organizations-organizationId-groups-groupId-invites-usernameOrEmail.
      operations:
      - method: DELETE
        name: deleteinvite
        description: Delete Invite to Group
        call: authorization-group-invites.deleteinvite
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
          usernameOrEmail: rest.usernameOrEmail
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: authorization-group-invites-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Authorization Server API — Group Invites. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-invites
      description: List Invites
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-group-invites.getinvites
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
      outputParameters:
      - type: object
        mapping: $.
    - name: invite-user-group
      description: Invite User to Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: authorization-group-invites.invitemember
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
        sendEmail: tools.sendEmail
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: accept-invite-group
      description: Accept Invite to Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: authorization-group-invites.acceptinvite
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
        invite_code: tools.invite_code
      outputParameters:
      - type: object
        mapping: $.
    - name: decline-invite-group
      description: Decline Invite to Group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: authorization-group-invites.declineinvite
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
        invite_code: tools.invite_code
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-invite-group
      description: Delete Invite to Group
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: authorization-group-invites.deleteinvite
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
        usernameOrEmail: tools.usernameOrEmail
      outputParameters:
      - type: object
        mapping: $.