Domains

Used to interact with the members of an organization. The current user must be an administrator to access them.

Create Organization Domain

Create a new organization domain.

The current user must have permissions to manage the domains of the organization.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

Request Body schema: application/x-www-form-urlencoded
required
name
string

The name of the new domain

Responses
200

Returns the response for Client wrapped OrganizationDomain object.

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/organizations/{organization_id}/domains
Request samples
application/x-www-form-urlencoded
name=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Get All Organization Domains

Retrieves a list of all the domains in an organization

The current user must have permissions to manage the domains of the organization.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

query Parameters
limit
number
offset
number
Responses
200

Returns the response for Client wrapped array of OrganizationDomain objects.

401

Request was not successful

403

Request was not successful

422

Request was not successful

get/v1/organizations/{organization_id}/domains
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Get Organization Domain

Retrieve all properties for a domain of an organization.

The current user must have permissions to manage the domains of the organization.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

domain_id
required
string

The domains ID.

Request Body schema: application/x-www-form-urlencoded
name
string
Responses
200

Returns the response for Client wrapped OrganizationDomain object.

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

get/v1/organizations/{organization_id}/domains/{domain_id}
Request samples
application/x-www-form-urlencoded
name=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Delete Organization Domain

Remove a domain from an organization.

The current user must have permissions to manage the domains of the organization.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

domain_id
required
string

The domain ID.

Responses
200

Returns a deleted organization domain.

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

delete/v1/organizations/{organization_id}/domains/{domain_id}
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Update Organization Enrollment Mode

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.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

domain_id
required
string

The domain ID.

Request Body schema: application/x-www-form-urlencoded
enrollment_mode
string
delete_pending
boolean or null
Responses
200

Returns the response for Client wrapped OrganizationDomain object.

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/organizations/{organization_id}/domains/{domain_id}/update_enrollment_mode
Request samples
application/x-www-form-urlencoded
enrollment_mode=string&delete_pending=true
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Prepare Organization Domain Affiliation Verification

Prepares affiliation verification for an organization domain.

The current user must have permissions to manage the domains of the organization.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

domain_id
required
string

The domain ID.

Request Body schema: application/x-www-form-urlencoded
affiliation_email_address
string
Responses
200

Returns the response for Client wrapped OrganizationDomain object.

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/organizations/{organization_id}/domains/{domain_id}/prepare_affiliation_verification
Request samples
application/x-www-form-urlencoded
affiliation_email_address=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Attempt Organization Domain Affiliation Verification

Attempts affiliation verification for organization domain

The current user must have permissions to manage the domains of the organization.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
path Parameters
organization_id
required
string

The organization ID.

domain_id
required
string

The domain ID.

Request Body schema: application/x-www-form-urlencoded
code
string

The code that was sent to the email address.

Responses
200

Returns the response for Client wrapped OrganizationDomain object.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/organizations/{organization_id}/domains/{domain_id}/attempt_affiliation_verification
Request samples
application/x-www-form-urlencoded
code=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}