naftiko: 1.0.0-alpha2
info:
  label: Clerk Backend Api — Organization Domains
  description: 'Clerk Organization Domains capability. 5 operations. Lead operation: Create a New Organization Domain..'
  tags:
  - Clerk
  - Organization 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-organization-domains
    baseUri: https://api.clerk.com/v1
    description: Clerk clerk-backend-api Organization Domains business capability.
    resources:
    - name: organizations-organization-id-domains
      path: /organizations/{organization_id}/domains
      operations:
      - name: CreateOrganizationDomain
        method: POST
        description: Create a New Organization Domain.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The ID of the organization where the new domain will be created.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: ListOrganizationDomains
        method: GET
        description: Get a List of All Domains of an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The organization ID.
          required: true
        - name: verified
          in: query
          type: string
          description: Filter domains by their verification status. `true` or `false`
          required: false
        - name: enrollment_mode
          in: query
          type: string
          description: Filter domains by their enrollment mode
          required: false
    - name: organizations-organization-id-domains-domain-id
      path: /organizations/{organization_id}/domains/{domain_id}
      operations:
      - name: UpdateOrganizationDomain
        method: PATCH
        description: Update an Organization Domain.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The ID of the organization to which the domain belongs
          required: true
        - name: domain_id
          in: path
          type: string
          description: The ID of the domain
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: DeleteOrganizationDomain
        method: DELETE
        description: Remove a Domain from an Organization.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: path
          type: string
          description: The ID of the organization to which the domain belongs
          required: true
        - name: domain_id
          in: path
          type: string
          description: The ID of the domain
          required: true
    - name: organization-domains
      path: /organization_domains
      operations:
      - name: ListAllOrganizationDomains
        method: GET
        description: List All Organization Domains
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: organization_id
          in: query
          type: string
          description: The ID of the organization to filter domains by
          required: false
        - name: verified
          in: query
          type: string
          description: Filter by verification status
          required: false
        - name: enrollment_mode
          in: query
          type: array
          description: Filter by enrollment mode
          required: false
        - name: query
          in: query
          type: string
          description: 'Search domains by name or organization ID.

            If the query starts with "org_", it will search by exact organization ID match.

            Otherwise, it performs a case-insensitive partial match on the domain name.


            '
          required: false
        - name: domains
          in: query
          type: array
          description: Filter by exact domain names. Accepts multiple values (e.g. domains=example.com&domains=test.org).
          required: false
        - name: order_by
          in: query
          type: string
          description: 'Allows to return organization domains in a particular order.

            At the moment, you can order the returned domains by their `name` or `created_at`.

            In order to specify the direction, you can use the `+/-`'
          required: false