Clerk Backend Api — Domains

naftiko: 1.0.0-alpha2
info:
  label: Clerk Backend Api — Domains
  description: 'Clerk Domains capability. 4 operations. Lead operation: List All Instance Domains.'
  tags:
  - Clerk
  - Domains
  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-domains
    baseUri: https://api.clerk.com/v1
    description: Clerk clerk-backend-api Domains business capability.
    resources:
    - name: domains
      path: /domains
      operations:
      - name: ListDomains
        method: GET
        description: List All Instance Domains
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: AddDomain
        method: POST
        description: Add a Domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: domains-domain-id
      path: /domains/{domain_id}
      operations:
      - name: DeleteDomain
        method: DELETE
        description: Delete a Satellite Domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: domain_id
          in: path
          type: string
          description: The ID of the domain that will be deleted. Must be a satellite domain.
          required: true
      - name: UpdateDomain
        method: PATCH
        description: Update a Domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: domain_id
          in: path
          type: string
          description: The ID of the domain that will be updated.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true