Clerk Domains API

Domains represent each instance's URLs and DNS setup.

OpenAPI Specification

clerk-com-domains-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Clerk Backend Account Portal Domains API
  x-logo:
    url: https://clerk.com/_next/image?url=%2Fimages%2Fclerk-logo.svg&w=96&q=75
    altText: Clerk docs
    href: https://clerk.com/docs
  contact:
    email: support@clerk.com
    name: Clerk Platform Team
    url: https://clerk.com/support
  description: 'The Clerk REST Backend API, meant to be accessed by backend servers.


    ### Versions


    When the API changes in a way that isn''t compatible with older versions, a new version is released.

    Each version is identified by its release date, e.g. `2025-04-10`. For more information, please see [Clerk API Versions](https://clerk.com/docs/versioning/available-versions).


    Please see https://clerk.com/docs for more information.'
  version: '2025-11-10'
  termsOfService: https://clerk.com/terms
  license:
    name: MIT
    url: https://github.com/clerk/openapi-specs/blob/main/LICENSE
servers:
- url: https://api.clerk.com/v1
security:
- bearerAuth: []
tags:
- name: Domains
  description: Domains represent each instance's URLs and DNS setup.
paths:
  /domains:
    get:
      operationId: ListDomains
      x-speakeasy-group: domains
      x-speakeasy-name-override: list
      summary: List All Instance Domains
      description: 'Use this endpoint to get a list of all domains for an instance.

        The response will contain the primary domain for the instance and any satellite domains. Each domain in the response contains information about the URLs where Clerk operates and the required CNAME targets.'
      tags:
      - Domains
      responses:
        '200':
          $ref: '#/components/responses/Domains'
    post:
      summary: Add a Domain
      operationId: AddDomain
      x-speakeasy-group: domains
      x-speakeasy-name-override: add
      description: 'Add a new domain for your instance.

        Useful in the case of multi-domain instances, allows adding satellite domains to an instance.

        The new domain must have a `name`. The domain name can contain the port for development instances, like `localhost:3000`.

        At the moment, instances can have only one primary domain, so the `is_satellite` parameter must be set to `true`.

        If you''re planning to configure the new satellite domain to run behind a proxy, pass the `proxy_url` parameter accordingly.'
      tags:
      - Domains
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The new domain name. Can contain the port for development instances.
                is_satellite:
                  type: boolean
                  description: Marks the new domain as satellite. Only `true` is accepted at the moment.
                  enum:
                  - true
                proxy_url:
                  type: string
                  description: The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. Applicable only to production instances.
                  nullable: true
              required:
              - name
              - is_satellite
      responses:
        '200':
          $ref: '#/components/responses/Domain'
        '400':
          $ref: '#/components/responses/ClerkErrors'
        '402':
          $ref: '#/components/responses/ClerkErrors'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /domains/{domain_id}:
    delete:
      operationId: DeleteDomain
      x-speakeasy-group: domains
      x-speakeasy-name-override: delete
      summary: Delete a Satellite Domain
      description: 'Deletes a satellite domain for the instance.

        It is currently not possible to delete the instance''s primary domain.'
      tags:
      - Domains
      parameters:
      - in: path
        name: domain_id
        required: true
        schema:
          type: string
        description: The ID of the domain that will be deleted. Must be a satellite domain.
      responses:
        '200':
          $ref: '#/components/responses/DeletedObject'
        '403':
          $ref: '#/components/responses/ClerkErrors'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
    patch:
      operationId: UpdateDomain
      x-speakeasy-group: domains
      x-speakeasy-name-override: update
      summary: Update a Domain
      description: 'The `proxy_url` can be updated only for production instances.

        Update one of the instance''s domains. Both primary and satellite domains can be updated.

        If you choose to use Clerk via proxy, use this endpoint to specify the `proxy_url`.

        Whenever you decide you''d rather switch to DNS setup for Clerk, simply set `proxy_url`

        to `null` for the domain. When you update a production instance''s primary domain name,

        you have to make sure that you''ve completed all the necessary setup steps for DNS and

        emails to work. Expect downtime otherwise. Updating a primary domain''s name will also

        update the instance''s home origin, affecting the default application paths.'
      tags:
      - Domains
      parameters:
      - in: path
        name: domain_id
        required: true
        schema:
          type: string
        description: The ID of the domain that will be updated.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  description: 'The new domain name. For development instances, can contain the port,

                    i.e `myhostname:3000`. For production instances, must be a valid FQDN,

                    i.e `mysite.com`. Cannot contain protocol scheme.'
                  nullable: true
                proxy_url:
                  type: string
                  description: 'The full URL of the proxy that will forward requests to Clerk''s Frontend API.

                    Can only be updated for production instances.'
                  nullable: true
                is_secondary:
                  type: boolean
                  description: 'Whether this is a domain for a secondary app, meaning that any subdomain provided is significant and

                    will be stored as part of the domain. This is useful for supporting multiple apps (one primary and

                    multiple secondaries) on the same root domain (eTLD+1).'
                  nullable: true
      responses:
        '200':
          $ref: '#/components/responses/Domain'
        '400':
          $ref: '#/components/responses/ClerkErrors'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /v1/organizations/{organization_id}/domains:
    post:
      summary: Create Organization Domain
      description: 'Create a new organization domain.


        The current user must have permissions to manage the domains of the organization.'
      tags:
      - Domains
      operationId: CreateOrganizationDomain
      parameters:
      - in: path
        required: true
        name: organization_id
        schema:
          type: string
        description: The organization ID.
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                  description: The name of the new domain
                  nullable: false
              required:
              - name
      responses:
        '200':
          $ref: '#/components/responses/Client.ClientWrappedOrganizationDomain'
        '401':
          $ref: '#/components/responses/ClerkErrors'
        '403':
          $ref: '#/components/responses/ClerkErrors'
        '404':
          $ref: '#/components/responses/ClerkErrors'
        '422':
          $ref: '#/components/responses/ClerkErrors'
    get:
      summary: Get All Organization Domains
      description: 'Retrieves a list of all the domains in an organization


        The current user must have permissions to manage the domains of the organization.'
      tags:
      - Domains
      operationId: ListOrganizationDomains
      parameters:
      - $ref: '#/components/parameters/LimitParameter'
      - $ref: '#/components/parameters/OffsetParameter'
      - in: path
        name: organization_id
        description: The organization ID.
        required: true
        schema:
          type: string
      - in: query
        name: verified
        description: Filter by whether a domain is verified
        required: false
        schema:
          type: boolean
      - in: query
        name: enrollment_mode
        description: Filter by enrollment mode
        required: false
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/Client.ClientWrappedOrganizationDomains'
        '401':
          $ref: '#/components/responses/ClerkErrors'
        '403':
          $ref: '#/components/responses/ClerkErrors'
        '422':
          $ref: '#/components/responses/ClerkErrors'
  /v1/organizations/{organization_id}/domains/{domain_id}:
    get:
      summary: Get Organization Domain
      description: 'Retrieve all properties for a domain of an organization.


        The current user must have permissions to manage the domains of the organization.'
      tags:
      - Domains
      operationId: GetOrganizationDomain
      parameters:
      - in: path
        required: true
        name: organization_id
        schema:
          type: string
        description: The organization ID.
      - in: path
        required: true
        name: domain_id
        schema:
          type: string
        description: The domain ID.
      responses:
        '200':
          $ref: '#/components/responses/Client.ClientWrappedOrganizationDomain'
        '401':
          $ref: '#/components/responses/ClerkErrors'
        '403':
          $ref: '#/components/responses/ClerkErrors'
        '404':
          $ref: '#/components/responses/ClerkErrors'
        '422':
          $ref: '#/components/responses/ClerkErrors'
    delete:
      summary: Delete Organization Domain
      description: 'Remove a domain from an organization.


        The current user must have permissions to manage the domains of the organization.'
      tags:
      - Domains
      operationId: deleteOrganizationDomain
      parameters:
      - in: path
        required: true
        name: organization_id
        schema:
          type: string
        description: The organization ID.
      - in: path
        required: true
        name: domain_id
        schema:
          type: string
        description: The domain ID.
      responses:
        '200':
          $ref: '#/components/responses/Client.DeletedOrganizationDomain'
        '401':
          $ref: '#/components/responses/ClerkErrors'
        '403':
          $ref: '#/components/responses/ClerkErrors'
        '404':
          $ref: '#/components/responses/ClerkErrors'
        '422':
          $ref: '#/components/responses/ClerkErrors'
  /v1/organizations/{organization_id}/domains/{domain_id}/update_enrollment_mode:
    post:
      summary: Update Organization Enrollment Mode
      description: 'Update the enrollment mode for an organization domain.


        This can be either `automatic_invitation` or `automatic_suggestion`.


        The current user must have permissions to manage the domains of the organization.'
      tags:
      - Domains
      operationId: UpdateOrganizationDomainEnrollmentMode
      parameters:
      - in: path
        required: true
        name: organization_id
        schema:
          type: string
        description: The organization ID.
      - in: path
        required: true
        name: domain_id
        schema:
          type: string
        description: The domain ID.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: false
              properties:
                enrollment_mode:
                  type: string
                  nullable: false
                delete_pending:
                  type: boolean
                  nullable: true
              required:
              - enrollment_mode
      responses:
        '200':
          $ref: '#/components/responses/Client.ClientWrappedOrganizationDomain'
        '401':
          $ref: '#/components/responses/ClerkErrors'
        '403':
          $ref: '#/components/responses/ClerkErrors'
        '404':
          $ref: '#/components/responses/ClerkErrors'
        '422':
          $ref: '#/components/responses/ClerkErrors'
  /v1/organizations/{organization_id}/domains/{domain_id}/prepare_affiliation_verification:
    post:
      summary: Prepare Organization Domain Affiliation Verification
      description: 'Prepares affiliation verification for an organization domain.


        The current user must have permissions to manage the domains of the organization.'
      tags:
      - Domains
      operationId: prepareOrganizationDomainVerification
      parameters:
      - in: path
        required: true
        name: organization_id
        schema:
          type: string
        description: The organization ID.
      - in: path
        required: true
        name: domain_id
        schema:
          type: string
        description: The domain ID.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: false
              properties:
                affiliation_email_address:
                  type: string
                  nullable: false
              required:
              - affiliation_email_address
      responses:
        '200':
          $ref: '#/components/responses/Client.ClientWrappedOrganizationDomain'
        '401':
          $ref: '#/components/responses/ClerkErrors'
        '403':
          $ref: '#/components/responses/ClerkErrors'
        '404':
          $ref: '#/components/responses/ClerkErrors'
        '422':
          $ref: '#/components/responses/ClerkErrors'
  /v1/organizations/{organization_id}/domains/{domain_id}/attempt_affiliation_verification:
    post:
      summary: Attempt Organization Domain Affiliation Verification
      description: 'Attempts affiliation verification for organization domain


        The current user must have permissions to manage the domains of the organization.'
      tags:
      - Domains
      operationId: attemptOrganizationDomainVerification
      parameters:
      - in: path
        required: true
        name: organization_id
        schema:
          type: string
        description: The organization ID.
      - in: path
        required: true
        name: domain_id
        schema:
          type: string
        description: The domain ID.
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              additionalProperties: false
              properties:
                code:
                  type: string
                  description: The code that was sent to the email address.
                  nullable: false
              required:
              - code
      responses:
        '200':
          $ref: '#/components/responses/Client.ClientWrappedOrganizationDomain'
        '400':
          $ref: '#/components/responses/ClerkErrors'
        '401':
          $ref: '#/components/responses/ClerkErrors'
        '403':
          $ref: '#/components/responses/ClerkErrors'
        '404':
          $ref: '#/components/responses/ClerkErrors'
        '422':
          $ref: '#/components/responses/ClerkErrors'
  /platform/applications/{applicationID}/domain:
    patch:
      operationId: PlatformUpdateApplicationDomain
      x-speakeasy-group: platform
      x-speakeasy-name-override: updateApplicationDomain
      tags:
      - Domains
      summary: Update Application Domain
      description: 'Update the production domain for an application.

        '
      security:
      - platform_api_access_token: []
      parameters:
      - name: applicationID
        in: path
        description: Application ID.
        required: true
        schema:
          type: string
      requestBody:
        description: Domain data to update.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformUpdateApplicationDomainRequest'
      responses:
        '200':
          description: Application domain updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformDomainResponse'
        '400':
          $ref: '#/components/responses/ClerkErrors'
        '401':
          $ref: '#/components/responses/AuthenticationInvalid'
        '403':
          $ref: '#/components/responses/AuthorizationInvalid'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /platform/applications/{applicationID}/domains:
    get:
      operationId: PlatformListApplicationDomains
      x-speakeasy-group: platform
      x-speakeasy-name-override: listApplicationDomains
      tags:
      - Domains
      summary: List Application Domains
      description: 'List all domains for an application''s production instance.

        '
      security:
      - platform_api_access_token: []
      parameters:
      - name: applicationID
        in: path
        description: Application ID.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Application domains retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformListApplicationDomainsResponse'
        '401':
          $ref: '#/components/responses/AuthenticationInvalid'
        '403':
          $ref: '#/components/responses/AuthorizationInvalid'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
    post:
      operationId: PlatformCreateApplicationDomain
      x-speakeasy-group: platform
      x-speakeasy-name-override: createApplicationDomain
      tags:
      - Domains
      summary: Create Application Domain
      description: 'Create a provider domain for an application''s production instance.

        '
      security:
      - platform_api_access_token: []
      parameters:
      - name: applicationID
        in: path
        description: Application ID.
        required: true
        schema:
          type: string
      requestBody:
        description: Domain data to create.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformCreateApplicationDomainRequest'
      responses:
        '201':
          description: Application domain created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformDomainResponse'
        '400':
          $ref: '#/components/responses/ClerkErrors'
        '401':
          $ref: '#/components/responses/AuthenticationInvalid'
        '403':
          $ref: '#/components/responses/AuthorizationInvalid'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /platform/applications/{applicationID}/domains/{domainIDOrName}:
    get:
      operationId: PlatformGetApplicationDomain
      x-speakeasy-group: platform
      x-speakeasy-name-override: getApplicationDomain
      tags:
      - Domains
      summary: Get Application Domain
      description: 'Get domain information for an application.

        '
      security:
      - platform_api_access_token: []
      parameters:
      - name: applicationID
        in: path
        description: Application ID.
        required: true
        schema:
          type: string
      - name: domainIDOrName
        in: path
        description: Domain ID or domain name.
        example: dmn_abcdefghijklmnopqrstuvwxyz0
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Application domain retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformDomainResponse'
        '400':
          $ref: '#/components/responses/ClerkErrors'
        '401':
          $ref: '#/components/responses/AuthenticationInvalid'
        '403':
          $ref: '#/components/responses/AuthorizationInvalid'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
    delete:
      operationId: PlatformDeleteApplicationDomain
      x-speakeasy-group: platform
      x-speakeasy-name-override: deleteApplicationDomain
      tags:
      - Domains
      summary: Delete Application Domain
      description: 'Delete a provider domain from an application''s production instance.


        Only provider domains can be deleted. The primary domain cannot be deleted.

        '
      security:
      - platform_api_access_token: []
      parameters:
      - name: applicationID
        in: path
        description: Application ID.
        required: true
        schema:
          type: string
      - name: domainIDOrName
        in: path
        description: Domain ID or domain name.
        example: dmn_abcdefghijklmnopqrstuvwxyz0
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Application domain deleted successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformDeletedObjectResponse'
        '400':
          $ref: '#/components/responses/ClerkErrors'
        '401':
          $ref: '#/components/responses/AuthenticationInvalid'
        '403':
          $ref: '#/components/responses/AuthorizationInvalid'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /platform/applications/{applicationID}/domains/{domainIDOrName}/status:
    get:
      operationId: PlatformGetApplicationDomainStatus
      x-speakeasy-group: platform
      x-speakeasy-name-override: getApplicationDomainStatus
      tags:
      - Domains
      summary: Get Application Domain Status
      description: 'Get the status of a domain for an application.

        '
      security:
      - platform_api_access_token: []
      parameters:
      - name: applicationID
        in: path
        description: Application ID.
        required: true
        schema:
          type: string
      - name: domainIDOrName
        in: path
        description: Domain ID or domain name.
        example: dmn_abcdefghijklmnopqrstuvwxyz0
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Application domain status retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformDomainStatusResponse'
        '400':
          $ref: '#/components/responses/ClerkErrors'
        '401':
          $ref: '#/components/responses/AuthenticationInvalid'
        '403':
          $ref: '#/components/responses/AuthorizationInvalid'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
  /platform/applications/{applicationID}/domains/{domainIDOrName}/dns_check:
    post:
      operationId: PlatformTriggerDNSCheck
      x-speakeasy-group: platform
      x-speakeasy-name-override: triggerDNSCheck
      tags:
      - Domains
      summary: Trigger DNS Check
      description: 'Triggers a DNS check for a domain and returns the current domain status.


        This endpoint ensures that at most one DNS check job is in-flight at any time.

        If a check is already running or was recently performed, a 409 Conflict is returned.


        Use this endpoint to trigger a new DNS verification check after configuring DNS records.

        '
      security:
      - platform_api_access_token: []
      parameters:
      - name: applicationID
        in: path
        description: Application ID.
        required: true
        schema:
          type: string
      - name: domainIDOrName
        in: path
        description: Domain ID or domain name.
        example: dmn_abcdefghijklmnopqrstuvwxyz0
        required: true
        schema:
          type: string
      responses:
        '200':
          description: DNS check triggered and domain status returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformDNSCheckResponse'
        '400':
          $ref: '#/components/responses/ClerkErrors'
        '401':
          $ref: '#/components/responses/AuthenticationInvalid'
        '403':
          $ref: '#/components/responses/AuthorizationInvalid'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '409':
          $ref: '#/components/responses/Conflict'
  /platform/domains:
    get:
      operationId: PlatformListDomains
      x-speakeasy-group: platform
      x-speakeasy-name-override: listDomains
      tags:
      - Domains
      summary: List Domains
      description: 'List production instance domains for applications in the authenticated workspace.

        Results are sorted by domain creation time in descending order (most recent first).


        Set `include_development` to include development instance domains.

        '
      security:
      - platform_api_access_token: []
      parameters:
      - name: name
        in: query
        description: Filter domains whose name contains this substring (case-insensitive).
        required: false
        schema:
          type: string
      - name: include_development
        in: query
        description: When `true`, include development instance domains. Defaults to production only.
        required: false
        schema:
          type: string
          enum:
          - 'true'
      - name: limit
        in: query
        description: Number of results to return per page (1-500, default 10).
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 500
          default: 10
      - name: starting_after
        in: query
        description: 'Cursor for pagination. Provide the ID of the last domain from the

          previous page to get the next page of results.

          '
        required: false
        schema:
          type: string
      - name: ending_before
        in: query
        description: 'Cursor for pagination. Provide the ID of the first domain from the

          previous page to get the previous page of results.

          '
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Domains retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformListDomainsResponse'
        '401':
          $ref: '#/components/responses/AuthenticationInvalid'
        '403':
          $ref: '#/components/responses/AuthorizationInvalid'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
  /platform/domains/{domainIDOrName}:
    get:
      operationId: PlatformGetDomain
      x-speakeasy-group: platform
      x-speakeasy-name-override: getDomain
      tags:
      - Domains
      summary: Get Domain
      description: 'Retrieve a single domain by ID or name for the authenticated workspace.

        '
      security:
      - platform_api_access_token: []
      parameters:
      - name: domainIDOrName
        in: path
        description: Domain ID or domain name.
        example: dmn_abcdefghijklmnopqrstuvwxyz0
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Domain retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformWorkspaceDomainResponse'
        '401':
          $ref: '#/components/responses/AuthenticationInvalid'
        '403':
          $ref: '#/components/responses/AuthorizationInvalid'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
components:
  schemas:
    Stubs.Verification.GoogleOneTap:
      type: object
      additionalProperties: false
      properties:
        object:
          type: string
          enum:
          - verification_google_one_tap
        status:
          type: string
          enum:
          - unverified
          - verified
        strategy:
          type: string
          enum:
          - google_one_tap
        expire_at:
          type: integer
          nullable: true
        attempts:
          type: integer
          nullable: true
      required:
      - status
      - strategy
    Stubs.Verification.SAML:
      type: object
      properties:
        object:
          type: string
          enum:
          - verification_saml
        status:
          type: string
          enum:
          - unverified
          - verified
          - failed
          - expired
          - transferable
        strategy:
          type: string
          enum:
          - saml
        external_verification_redirect_url:
          nullable: true
          type: string
        error:
          allOf:
          - $ref: '#/components/schemas/ClerkError'
          - type: object
            nullable: true
        expire_at:
          type: integer
          nullable: true
        attempts:
          type: integer
          nullable: true
      required:
      - status
      - strategy
    CNAMEStatus:
      type: object
      additionalProperties: false
      properties:
        actual:
          type: array
          items:
            type: string
        clerk_subdomain:
          type: string
        from:
          type: string
        to:
          type: string
        verified:
          type: boolean
        required:
          type: boolean
        failure_hints:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/FailureHint'
      required:
      - clerk_subdomain
      - from
      - to
      - verified
      - required
      - failure_hints
    Client.EmailAddress:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
        object:
          type: string
          description: 'String representing the object''s type. Objects of the same type share the same value.

            '
          enum:
          - email_address
        email_address:
          type: string
        reserved:
          type: boolean
        verification:
          type: object
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/Stubs.Verification.OTP'
          - $ref: '#/components/schemas/Stubs.Verification.Invitation'
          - $ref: '#/components/schemas/Stubs.Verification.Link'
          - $ref: '#/components/schemas/Stubs.Verification.Ticket'
          - $ref: '#/components/schemas/Stubs.Verification.Admin'
          - $ref: '#/components/schemas/Stubs.Verification.FromOauth'
          - $ref: '#/components/schemas/Stubs.Verification.SAML'
        linked_to:
          type: array
          items:
            $ref: '#/components/schemas/Stubs.Identification.Link'
        matches_sso_connection:
          description: 'Indicates whether this email address domain matches an active enterprise connection.

            '
          type: boolean
        created_at:
          type: integer
          format: int64
          description: 'Unix timestamp of creation

            '
        updated_at:
          type: integer
          format: int64
          description: 'Unix timestamp of creation

            '
      required:
      - i

# --- truncated at 32 KB (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clerk-com/refs/heads/main/openapi/clerk-com-domains-api-openapi.yml