Coveo Authorization Server API — Api Keys

naftiko: 1.0.0-alpha2
info:
  label: Coveo Authorization Server API — Api Keys
  description: 'Coveo Authorization Server API — Api Keys. 13 operations. Lead operation: List API Keys. Self-contained Naftiko
    capability covering one Coveo business surface.'
  tags:
  - Coveo
  - Authorization Server
  - Api Keys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COVEO_API_KEY: COVEO_API_KEY
capability:
  consumes:
  - type: http
    namespace: authorization-api-keys
    baseUri: https://platform.cloud.coveo.com
    description: Coveo Authorization Server API — Api Keys business capability. Self-contained, no shared references.
    authentication:
      type: bearer
      token: '{{env.COVEO_API_KEY}}'
    resources:
    - name: rest-organizations-organizationId-apikeys
      path: /rest/organizations/{organizationId}/apikeys
      operations:
      - name: getapikeys
        method: GET
        description: List API Keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organizationId
          in: path
          type: string
          description: The unique identifier of the organization
          required: true
        - name: status
          in: query
          type: string
          description: Optional filter for API key status
      - name: createapikey
        method: POST
        description: Create API Key
        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: apiKeyTemplateId
          in: query
          type: string
          description: The unique identifier of the template on which to base the API key.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: rest-organizations-organizationId-apikeys-activate-bulk
      path: /rest/organizations/{organizationId}/apikeys/activate/bulk
      operations:
      - name: bulkactivateapikey
        method: PUT
        description: Activate API Keys
        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-apikeys-delete-bulk
      path: /rest/organizations/{organizationId}/apikeys/delete/bulk
      operations:
      - name: bulkdeleteapikey
        method: POST
        description: Delete API Keys
        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-apikeys-disable-bulk
      path: /rest/organizations/{organizationId}/apikeys/disable/bulk
      operations:
      - name: bulkdisableapikey
        method: PUT
        description: Disable Multiple API Keys
        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-apikeys-rotate
      path: /rest/organizations/{organizationId}/apikeys/rotate
      operations:
      - name: rotateapikey
        method: POST
        description: Rotate API Key
        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-apikeys-apiKeyId
      path: /rest/organizations/{organizationId}/apikeys/{apiKeyId}
      operations:
      - name: getapikey
        method: GET
        description: Show API Key
        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: apiKeyId
          in: path
          type: string
          description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`
          required: true
      - name: updateapikey
        method: PUT
        description: Update API Key
        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: apiKeyId
          in: path
          type: string
          description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
            the apiKeyId](https://docs.coveo.com/en/38/).
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteapikey
        method: DELETE
        description: Delete API Key
        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: apiKeyId
          in: path
          type: string
          description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
            the apiKeyId](https://docs.coveo.com/en/38/).
          required: true
    - name: rest-organizations-organizationId-apikeys-apiKeyId-activate
      path: /rest/organizations/{organizationId}/apikeys/{apiKeyId}/activate
      operations:
      - name: activateapikey
        method: PUT
        description: Activate API Key
        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: apiKeyId
          in: path
          type: string
          description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
            the apiKeyId](https://docs.coveo.com/en/38/).
          required: true
    - name: rest-organizations-organizationId-apikeys-apiKeyId-activation-extend
      path: /rest/organizations/{organizationId}/apikeys/{apiKeyId}/activation/extend
      operations:
      - name: extendactivation
        method: PUT
        description: Extend API Key Activation
        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: apiKeyId
          in: path
          type: string
          description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
            the apiKeyId](https://docs.coveo.com/en/38/).
          required: true
    - name: rest-organizations-organizationId-apikeys-apiKeyId-disable
      path: /rest/organizations/{organizationId}/apikeys/{apiKeyId}/disable
      operations:
      - name: disableapikey
        method: PUT
        description: Disable API Key
        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: apiKeyId
          in: path
          type: string
          description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
            the apiKeyId](https://docs.coveo.com/en/38/).
          required: true
    - name: rest-organizations-organizationId-apikeys-sourceApiKeyId-duplicate
      path: /rest/organizations/{organizationId}/apikeys/{sourceApiKeyId}/duplicate
      operations:
      - name: duplicateapikey
        method: PUT
        description: Duplicate API Key
        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: sourceApiKeyId
          in: path
          type: string
          description: The unique identifier of the API key. </br>**Example:** `t4hk287bfj5sg6wskg64ckk5a`</br>See [Getting
            the apiKeyId](https://docs.coveo.com/en/38/).
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
  exposes:
  - type: rest
    namespace: authorization-api-keys-rest
    port: 8080
    description: REST adapter for Coveo Authorization Server API — Api Keys. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/organizations/{organizationid}/apikeys
      name: rest-organizations-organizationid-apikeys
      description: REST surface for rest-organizations-organizationId-apikeys.
      operations:
      - method: GET
        name: getapikeys
        description: List API Keys
        call: authorization-api-keys.getapikeys
        with:
          organizationId: rest.organizationId
          status: rest.status
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createapikey
        description: Create API Key
        call: authorization-api-keys.createapikey
        with:
          organizationId: rest.organizationId
          apiKeyTemplateId: rest.apiKeyTemplateId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/apikeys/activate/bulk
      name: rest-organizations-organizationid-apikeys-activate-bulk
      description: REST surface for rest-organizations-organizationId-apikeys-activate-bulk.
      operations:
      - method: PUT
        name: bulkactivateapikey
        description: Activate API Keys
        call: authorization-api-keys.bulkactivateapikey
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/apikeys/delete/bulk
      name: rest-organizations-organizationid-apikeys-delete-bulk
      description: REST surface for rest-organizations-organizationId-apikeys-delete-bulk.
      operations:
      - method: POST
        name: bulkdeleteapikey
        description: Delete API Keys
        call: authorization-api-keys.bulkdeleteapikey
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/apikeys/disable/bulk
      name: rest-organizations-organizationid-apikeys-disable-bulk
      description: REST surface for rest-organizations-organizationId-apikeys-disable-bulk.
      operations:
      - method: PUT
        name: bulkdisableapikey
        description: Disable Multiple API Keys
        call: authorization-api-keys.bulkdisableapikey
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/apikeys/rotate
      name: rest-organizations-organizationid-apikeys-rotate
      description: REST surface for rest-organizations-organizationId-apikeys-rotate.
      operations:
      - method: POST
        name: rotateapikey
        description: Rotate API Key
        call: authorization-api-keys.rotateapikey
        with:
          organizationId: rest.organizationId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/apikeys/{apikeyid}
      name: rest-organizations-organizationid-apikeys-apikeyid
      description: REST surface for rest-organizations-organizationId-apikeys-apiKeyId.
      operations:
      - method: GET
        name: getapikey
        description: Show API Key
        call: authorization-api-keys.getapikey
        with:
          organizationId: rest.organizationId
          apiKeyId: rest.apiKeyId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateapikey
        description: Update API Key
        call: authorization-api-keys.updateapikey
        with:
          organizationId: rest.organizationId
          apiKeyId: rest.apiKeyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteapikey
        description: Delete API Key
        call: authorization-api-keys.deleteapikey
        with:
          organizationId: rest.organizationId
          apiKeyId: rest.apiKeyId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/apikeys/{apikeyid}/activate
      name: rest-organizations-organizationid-apikeys-apikeyid-activate
      description: REST surface for rest-organizations-organizationId-apikeys-apiKeyId-activate.
      operations:
      - method: PUT
        name: activateapikey
        description: Activate API Key
        call: authorization-api-keys.activateapikey
        with:
          organizationId: rest.organizationId
          apiKeyId: rest.apiKeyId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/apikeys/{apikeyid}/activation/extend
      name: rest-organizations-organizationid-apikeys-apikeyid-activation-extend
      description: REST surface for rest-organizations-organizationId-apikeys-apiKeyId-activation-extend.
      operations:
      - method: PUT
        name: extendactivation
        description: Extend API Key Activation
        call: authorization-api-keys.extendactivation
        with:
          organizationId: rest.organizationId
          apiKeyId: rest.apiKeyId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/apikeys/{apikeyid}/disable
      name: rest-organizations-organizationid-apikeys-apikeyid-disable
      description: REST surface for rest-organizations-organizationId-apikeys-apiKeyId-disable.
      operations:
      - method: PUT
        name: disableapikey
        description: Disable API Key
        call: authorization-api-keys.disableapikey
        with:
          organizationId: rest.organizationId
          apiKeyId: rest.apiKeyId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/organizations/{organizationid}/apikeys/{sourceapikeyid}/duplicate
      name: rest-organizations-organizationid-apikeys-sourceapikeyid-duplicate
      description: REST surface for rest-organizations-organizationId-apikeys-sourceApiKeyId-duplicate.
      operations:
      - method: PUT
        name: duplicateapikey
        description: Duplicate API Key
        call: authorization-api-keys.duplicateapikey
        with:
          organizationId: rest.organizationId
          sourceApiKeyId: rest.sourceApiKeyId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: authorization-api-keys-mcp
    port: 9090
    transport: http
    description: MCP adapter for Coveo Authorization Server API — Api Keys. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-api-keys
      description: List API Keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-api-keys.getapikeys
      with:
        organizationId: tools.organizationId
        status: tools.status
      outputParameters:
      - type: object
        mapping: $.
    - name: create-api-key
      description: Create API Key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: authorization-api-keys.createapikey
      with:
        organizationId: tools.organizationId
        apiKeyTemplateId: tools.apiKeyTemplateId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: activate-api-keys
      description: Activate API Keys
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-api-keys.bulkactivateapikey
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-api-keys
      description: Delete API Keys
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: authorization-api-keys.bulkdeleteapikey
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: disable-multiple-api-keys
      description: Disable Multiple API Keys
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-api-keys.bulkdisableapikey
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: rotate-api-key
      description: Rotate API Key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: authorization-api-keys.rotateapikey
      with:
        organizationId: tools.organizationId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: show-api-key
      description: Show API Key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: authorization-api-keys.getapikey
      with:
        organizationId: tools.organizationId
        apiKeyId: tools.apiKeyId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-api-key
      description: Update API Key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-api-keys.updateapikey
      with:
        organizationId: tools.organizationId
        apiKeyId: tools.apiKeyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-api-key
      description: Delete API Key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: authorization-api-keys.deleteapikey
      with:
        organizationId: tools.organizationId
        apiKeyId: tools.apiKeyId
      outputParameters:
      - type: object
        mapping: $.
    - name: activate-api-key
      description: Activate API Key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-api-keys.activateapikey
      with:
        organizationId: tools.organizationId
        apiKeyId: tools.apiKeyId
      outputParameters:
      - type: object
        mapping: $.
    - name: extend-api-key-activation
      description: Extend API Key Activation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-api-keys.extendactivation
      with:
        organizationId: tools.organizationId
        apiKeyId: tools.apiKeyId
      outputParameters:
      - type: object
        mapping: $.
    - name: disable-api-key
      description: Disable API Key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-api-keys.disableapikey
      with:
        organizationId: tools.organizationId
        apiKeyId: tools.apiKeyId
      outputParameters:
      - type: object
        mapping: $.
    - name: duplicate-api-key
      description: Duplicate API Key
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: authorization-api-keys.duplicateapikey
      with:
        organizationId: tools.organizationId
        sourceApiKeyId: tools.sourceApiKeyId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.