Retrieve an organization discovery domain by ID

Retrieve details about a single organization discovery domain specified by ID. This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.

GET https://{tenantDomain}/api/v2/organizations/{id}/discovery-domains/{discovery_domain_id}

Retrieve an organization discovery domain by ID

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{id}/discovery-domains/{discovery_domain_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "domain": "<string>",
  "status": "pending",
  "verification_txt": "<string>",
  "verification_host": "<string>",
  "use_for_organization_discovery": true
}

Authorizations

bearerAuthoAuth2ClientCredentials

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_id · string · required

ID of the discovery domain.

Response

200

application/json

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.