Update an organization discovery domain

curl --request PATCH \ --url https://{tenantDomain}/api/v2/organizations/{id}/discovery-domains/{discovery_domain_id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "status": "pending", "use_for_organization_discovery": true } '

Autorisations

Authorization

string

header

requis

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

Paramètres de chemin

string

requis

ID of the organization.

discovery_domain_id

string

requis

ID of the discovery domain to update.

Corps

status

enum<string>

The verification status of the discovery domain.

Options disponibles:

pending,

verified

use_for_organization_discovery

boolean

Indicates whether this domain should be used for organization discovery.

Réponse

Organization discovery domain successfully updated.

string<organization-discovery-domain-id>

requis

Organization discovery domain identifier.

domain

string

requis

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>

requis

The verification status of the discovery domain.

Options disponibles:

pending,

verified

verification_txt

string

requis

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

requis

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.