Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Organization Domains API

6 actions 6 updates phrasing extends openapi/clerk-com-organization-domains-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Clerk's API. It is a proposal applied on top of the contract, not a document Clerk publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/organizations/{organization_id}/domains'].get

$.paths['/organizations/{organization_id}/domains'].post

$.paths['/organizations/{organization_id}/domains/{domain_id}'].delete

$.paths['/organizations/{organization_id}/domains/{domain_id}'].patch

$.paths['/organization_domains'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Backend Organization Domains API
  version: 1.0.0
extends: openapi/clerk-com-organization-domains-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/organizations/{organization_id}/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List one organization's domains
      effect: read
      questions:
      - Which email domains are attached to a particular organization?
      - Can I list only the verified domains of one organization?
      instructions:
      - text: List the domains of organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show organization {organization_id}'s domains with enrollment mode {enrollment_mode}.
        slots:
          organization_id: path.organization_id
          enrollment_mode: query.enrollment_mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a domain to an organization
      effect: write
      questions:
      - How do I attach a company email domain to an organization so staff can join?
      - Can a new organization domain be added as unverified?
      instructions:
      - text: Add domain {name} to organization {organization_id}.
        slots:
          name: requestBody.name
          organization_id: path.organization_id
      - text: Add {name} to organization {organization_id} with enrollment mode {enrollment_mode}.
        slots:
          name: requestBody.name
          organization_id: path.organization_id
          enrollment_mode: requestBody.enrollment_mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/domains/{domain_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain from an organization
      effect: destructive
      questions:
      - How do I detach an email domain from an organization?
      - Can I delete a domain we no longer own from an organization?
      instructions:
      - text: Remove domain {domain_id} from organization {organization_id}.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
      - text: Detach {domain_id} from the organization {organization_id}.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/domains/{domain_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an organization domain's settings
      effect: write
      questions:
      - How do I switch an organization domain to automatic invitations?
      - Can I mark an existing organization domain as verified?
      instructions:
      - text: Set the enrollment mode of domain {domain_id} in organization {organization_id} to {enrollment_mode}.
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
          enrollment_mode: requestBody.enrollment_mode
      - text: 'Mark domain {domain_id} of organization {organization_id} as verified: {verified}.'
        slots:
          domain_id: path.domain_id
          organization_id: path.organization_id
          verified: requestBody.verified
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization_domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List domains across all organizations
      effect: read
      questions:
      - How do I see every organization domain across my whole instance?
      - Which organization owns a given domain in my instance?
      - Can I search all organization domains by verification status?
      instructions:
      - text: List every organization domain in the instance.
      - text: Find which organization claims the domains {domains}.
        slots:
          domains: query.domains
      - text: List organization domains instance-wide filtered by verified status {verified}.
        slots:
          verified: query.verified
      method: generated
      generated: '2026-09-26'