Clerk docs

Organization Domains

Create a new organization domain.

Creates a new organization domain. By default the domain is verified, but can be optionally set to unverified.

SecuritybearerAuth
Request
path Parameters
organization_id
required
string

The ID of the organization where the new domain will be created.

Request Body schema: application/json
required
name
string

The name of the new domain

enrollment_mode
string

The enrollment_mode for the new domain. This can be automatic_invitation, automatic_suggestion or manual_invitation

verified
boolean or null

The status of domain's verification. Defaults to true

Responses
200

An organization domain

400

Request was not successful

403

Authorization invalid

404

Resource not found

422

Invalid request parameters

post/organizations/{organization_id}/domains
Request samples
application/json
{
  • "name": "string",
  • "enrollment_mode": "string",
  • "verified": true
}
Response samples
application/json
{
  • "id": "string",
  • "object": "organization_domain",
  • "organization_id": "string",
  • "name": "string",
  • "enrollment_mode": "manual_invitation",
  • "affiliation_email_address": "string",
  • "verification": {
    },
  • "total_pending_invitations": 0,
  • "total_pending_suggestions": 0,
  • "created_at": 0,
  • "updated_at": 0
}

Get a list of all domains of an organization.

Get a list of all domains of an organization.

SecuritybearerAuth
Request
path Parameters
organization_id
required
string

The organization ID.

query Parameters
limit
number [ 1 .. 500 ]
Default: 10

Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

offset
number >= 0
Default: 0

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

verified
string

Filter domains by their verification status. true or false

enrollment_mode
string

Filter domains by their enrollment mode

Responses
200

A list of organization domains

401

Authentication invalid

422

Invalid request parameters

get/organizations/{organization_id}/domains
Response samples
application/json
{
  • "data": [
    ],
  • "total_count": 0
}

Update an organization domain.

Updates the properties of an existing organization domain.

SecuritybearerAuth
Request
path Parameters
organization_id
required
string

The ID of the organization the domain belongs to

domain_id
required
string

The ID of the domain

Request Body schema: application/json
required
enrollment_mode
string or null

The enrollment_mode for the new domain. This can be automatic_invitation, automatic_suggestion or manual_invitation

verified
boolean or null

The status of the domain's verification

Responses
200

An organization domain

400

Request was not successful

404

Resource not found

422

Invalid request parameters

patch/organizations/{organization_id}/domains/{domain_id}
Request samples
application/json
{
  • "enrollment_mode": "string",
  • "verified": true
}
Response samples
application/json
{
  • "id": "string",
  • "object": "organization_domain",
  • "organization_id": "string",
  • "name": "string",
  • "enrollment_mode": "manual_invitation",
  • "affiliation_email_address": "string",
  • "verification": {
    },
  • "total_pending_invitations": 0,
  • "total_pending_suggestions": 0,
  • "created_at": 0,
  • "updated_at": 0
}

Remove a domain from an organization.

Removes the given domain from the organization.

SecuritybearerAuth
Request
path Parameters
organization_id
required
string

The ID of the organization the domain belongs to

domain_id
required
string

The ID of the domain

Responses
200

Deleted Object

400

Request was not successful

401

Authentication invalid

404

Resource not found

delete/organizations/{organization_id}/domains/{domain_id}
Response samples
application/json
{
  • "object": "string",
  • "id": "string",
  • "slug": "string",
  • "deleted": true
}
➔ Next to Proxy checks