Coveo Authorization Server API — Organization Realms

naftiko: 1.0.0-alpha2
info:
  label: Coveo Authorization Server API — Organization Realms
  description: 'Coveo Authorization Server API — Organization Realms. 3 operations. Lead operation: List Realms. Self-contained
    Naftiko capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Authorization Server
  - Organization 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-organization-realms
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Authorization Server API — Organization Realms business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-realms
      path: /rest/organizations/{organizationId}/realms
      operations:
      - name: getorganizationrealms
        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: addrealmstogroups
        method: POST
        description: Add Realm for Groups
        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: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-organizations-organizationId-realms-realmId
      path: /rest/organizations/{organizationId}/realms/{realmId}
      operations:
      - name: updaterealmsingroups
        method: PUT
        description: Update 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 update.</br>**Example:** `website-domain-coveo.com`
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: authorization-organization-realms-rest
    port: 8080
    description: REST adapter for Coveo Authorization Server API — Organization Realms. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/realms
      name: rest-organizations-organizationid-realms
      description: REST surface for rest-organizations-organizationId-realms.
      operations:
      - method: GET
        name: getorganizationrealms
        description: List Realms
        call: authorization-organization-realms.getorganizationrealms
        with:
          organizationId: rest.organizationId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: addrealmstogroups
        description: Add Realm for Groups
        call: authorization-organization-realms.addrealmstogroups
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/realms/{realmid}
      name: rest-organizations-organizationid-realms-realmid
      description: REST surface for rest-organizations-organizationId-realms-realmId.
      operations:
      - method: PUT
        name: updaterealmsingroups
        description: Update Realm
        call: authorization-organization-realms.updaterealmsingroups
        with:
          organizationId: rest.organizationId
          realmId: rest.realmId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: authorization-organization-realms-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Authorization Server API — Organization 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-organization-realms.getorganizationrealms
      with:
        organizationId: tools.organizationId
      outputParameters:
      - type: object
        mapping: $.
    - name: add-realm-groups
      description: Add Realm for Groups
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: authorization-organization-realms.addrealmstogroups
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-realm
      description: Update Realm
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-organization-realms.updaterealmsingroups
      with:
        organizationId: tools.organizationId
        realmId: tools.realmId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.