Skip to main content
GET
/
organizations
/
{id}
/
discovery-domains
/
name
/
{discovery_domain}
Retrieve an organization discovery domain by domain name
curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{id}/discovery-domains/name/{discovery_domain} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "domain": "<string>",
  "status": "pending",
  "verification_txt": "<string>",
  "verification_host": "<string>",
  "use_for_organization_discovery": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

ID of the organization.

​
discovery_domain
string
required

Domain name of the discovery domain.

Response

Organization discovery domain successfully retrieved.

​
id
string<organization-discovery-domain-id>
required

Organization discovery domain identifier.

​
domain
string
required

The domain name to associate with the organization e.g. acme.com.

Required string length: 3 - 255
Pattern: ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$
​
status
enum<string>
required

The verification status of the discovery domain.

Available options:
pending,
verified
​
verification_txt
string
required

A unique token generated for the discovery domain. This must be placed in a DNS TXT record at the location specified by the verification_host field to prove domain ownership.

​
verification_host
string
required

The full domain where the TXT record should be added.

​
use_for_organization_discovery
boolean

Indicates whether this domain should be used for organization discovery.