Operations for the OrganizationDomains API.
Summary
Functions
Create an Organization Domain
Delete an Organization Domain
Get an Organization Domain
Verify an Organization Domain
Functions
@spec create_organization_domain(WorkOS.Client.t(), map(), keyword()) :: {:ok, WorkOS.OrganizationDomain.t()} | {:error, WorkOS.Error.error()}
Create an Organization Domain
Creates a new Organization Domain.
Parameters
params— request body mapopts— per-request options (seeWorkOS.Client.request/5)
@spec delete_organization_domain(WorkOS.Client.t(), String.t(), keyword()) :: {:ok, term()} | {:error, WorkOS.Error.error()}
Delete an Organization Domain
Permanently deletes an organization domain. It cannot be undone.
Parameters
id— Unique identifier of the organization domain.opts— per-request options (seeWorkOS.Client.request/5)
@spec get_organization_domain(WorkOS.Client.t(), String.t(), keyword()) :: {:ok, WorkOS.OrganizationDomain.t()} | {:error, WorkOS.Error.error()}
Get an Organization Domain
Get the details of an existing organization domain.
Parameters
id— Unique identifier of the organization domain.opts— per-request options (seeWorkOS.Client.request/5)
@spec verify_organization_domain(WorkOS.Client.t(), String.t(), keyword()) :: {:ok, WorkOS.OrganizationDomain.t()} | {:error, WorkOS.Error.error()}
Verify an Organization Domain
Initiates verification process for an Organization Domain.
Parameters
id— Unique identifier of the organization domain.opts— per-request options (seeWorkOS.Client.request/5)