Clerk Backend Api — API Keys

naftiko: 1.0.0-alpha2
info:
  label: Clerk Backend Api — API Keys
  description: 'Clerk API Keys capability. 8 operations. Lead operation: Create an API Key.'
  tags:
  - Clerk
  - API Keys
  created: '2026-05-22'
  modified: '2026-05-22'
binds:
- namespace: env
  keys:
    CLERK_SECRET_KEY: CLERK_SECRET_KEY
capability:
  consumes:
  - type: http
    namespace: clerk-backend-api-api-keys
    baseUri: https://api.clerk.com/v1
    description: Clerk clerk-backend-api API Keys business capability.
    resources:
    - name: api-keys
      path: /api_keys
      operations:
      - name: createApiKey
        method: POST
        description: Create an API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getApiKeys
        method: GET
        description: Get API Keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: string
          description: ''
          required: false
        - name: subject
          in: query
          type: string
          description: ''
          required: true
        - name: include_invalid
          in: query
          type: string
          description: ''
          required: false
        - name: limit
          in: query
          type: number
          description: ''
          required: false
        - name: offset
          in: query
          type: number
          description: ''
          required: false
        - name: query
          in: query
          type: string
          description: ''
          required: false
    - name: api-keys-apikeyid
      path: /api_keys/{apiKeyID}
      operations:
      - name: getApiKey
        method: GET
        description: Get an API Key by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apiKeyID
          in: path
          type: string
          description: ''
          required: true
      - name: updateApiKey
        method: PATCH
        description: Update an API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apiKeyID
          in: path
          type: string
          description: ''
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteApiKey
        method: DELETE
        description: Delete an API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apiKeyID
          in: path
          type: string
          description: ''
          required: true
    - name: api-keys-apikeyid-secret
      path: /api_keys/{apiKeyID}/secret
      operations:
      - name: getApiKeySecret
        method: GET
        description: Get an API Key Secret
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apiKeyID
          in: path
          type: string
          description: ''
          required: true
    - name: api-keys-apikeyid-revoke
      path: /api_keys/{apiKeyID}/revoke
      operations:
      - name: revokeApiKey
        method: POST
        description: Revoke an API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: apiKeyID
          in: path
          type: string
          description: ''
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-keys-verify
      path: /api_keys/verify
      operations:
      - name: verifyApiKey
        method: POST
        description: Verify an API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true