WorkOS.OrganizationDomains (WorkOS SDK for Elixir v3.0.1)

Copy Markdown View Source

Operations for the OrganizationDomains API.

Summary

Functions

create_organization_domain(client, params \\ %{}, opts \\ [])

@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

delete_organization_domain(client, id, opts \\ [])

@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

get_organization_domain(client, id, opts \\ [])

@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

verify_organization_domain(client, id, opts \\ [])

@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