Coveo Authorization Server API — Group Realms

naftiko: 1.0.0-alpha2
info:
  label: Coveo Authorization Server API — Group Realms
  description: 'Coveo Authorization Server API — Group Realms. 4 operations. Lead operation: List Realms. Self-contained Naftiko
    capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Authorization Server
  - Group Realms
  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-realms
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Authorization Server API — Group Realms business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-groups-groupId-realms
      path: /rest/organizations/{organizationId}/groups/{groupId}/realms
      operations:
      - name: getgrouprealms
        method: GET
        description: List Realms
        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: addgrouprealm
        method: POST
        description: Add Realm
        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: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-groups-groupId-realms-realmId
      path: /rest/organizations/{organizationId}/groups/{groupId}/realms/{realmId}
      operations:
      - name: getgrouprealm
        method: GET
        description: Show Realm
        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: realmId
          in: path
          type: string
          description: The unique identifier of the realm to show.</br>**Example:** `website-domain-coveo.com`
          required: true
      - name: deletegrouprealm
        method: DELETE
        description: Destroy Realm
        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: realmId
          in: path
          type: string
          description: The unique identifier of  the realm to delete.</br>**Example:** `website-domain-coveo.com`
          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-realms-rest
    port: 8080
    description: REST adapter for Coveo Authorization Server API — Group Realms. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/groups/{groupid}/realms
      name: rest-organizations-organizationid-groups-groupid-realms
      description: REST surface for rest-organizations-organizationId-groups-groupId-realms.
      operations:
      - method: GET
        name: getgrouprealms
        description: List Realms
        call: authorization-group-realms.getgrouprealms
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addgrouprealm
        description: Add Realm
        call: authorization-group-realms.addgrouprealm
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/groups/{groupid}/realms/{realmid}
      name: rest-organizations-organizationid-groups-groupid-realms-realmid
      description: REST surface for rest-organizations-organizationId-groups-groupId-realms-realmId.
      operations:
      - method: GET
        name: getgrouprealm
        description: Show Realm
        call: authorization-group-realms.getgrouprealm
        with:
          organizationId: rest.organizationId
          groupId: rest.groupId
          realmId: rest.realmId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletegrouprealm
        description: Destroy Realm
        call: authorization-group-realms.deletegrouprealm
        with:
          organizationId: rest.organizationId
          realmId: rest.realmId
          groupId: rest.groupId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: authorization-group-realms-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Authorization Server API — Group Realms. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-realms
      description: List Realms
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-group-realms.getgrouprealms
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
      outputParameters:
      - type: object
        mapping: $.
    - name: add-realm
      description: Add Realm
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: authorization-group-realms.addgrouprealm
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: show-realm
      description: Show Realm
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-group-realms.getgrouprealm
      with:
        organizationId: tools.organizationId
        groupId: tools.groupId
        realmId: tools.realmId
      outputParameters:
      - type: object
        mapping: $.
    - name: destroy-realm
      description: Destroy Realm
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: authorization-group-realms.deletegrouprealm
      with:
        organizationId: tools.organizationId
        realmId: tools.realmId
        groupId: tools.groupId
      outputParameters:
      - type: object
        mapping: $.