docs/classes/management.SDK.DiscoveryDomainsClient.html
listcreategetByNamegetdeleteupdate
new DiscoveryDomainsClient(options: BaseClientOptions): DiscoveryDomainsClient
list(
id: string,
request?: ListOrganizationDiscoveryDomainsRequestParameters,
requestOptions?: DiscoveryDomainsClient.RequestOptions,
): Promise<
Page<
OrganizationDiscoveryDomain,
ListOrganizationDiscoveryDomainsResponseContent,
>,
>
Retrieve list of all organization discovery domains associated with the specified organization. This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.
ID of the organization.
OptionalrequestOptions: DiscoveryDomainsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.discoveryDomains.list("id", { from: "from", take: 1 })Copy
create(
id: string,
request: CreateOrganizationDiscoveryDomainRequestContent,
requestOptions?: DiscoveryDomainsClient.RequestOptions,
): HttpResponsePromise<CreateOrganizationDiscoveryDomainResponseContent>
Create a new discovery domain for an organization.
ID of the organization.
OptionalrequestOptions: DiscoveryDomainsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.discoveryDomains.create("id", { domain: "domain" })Copy
getByName(
id: string,
discovery_domain: string,
requestOptions?: DiscoveryDomainsClient.RequestOptions,
): HttpResponsePromise<GetOrganizationDiscoveryDomainByNameResponseContent>
Retrieve details about a single organization discovery domain specified by domain name. This endpoint is subject to eventual consistency; newly created, updated, or deleted discovery domains may not immediately appear in the response.
ID of the organization.
Domain name of the discovery domain.
OptionalrequestOptions: DiscoveryDomainsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.discoveryDomains.getByName("id", "discovery_domain")Copy
get(
id: string,
discovery_domain_id: string,
requestOptions?: DiscoveryDomainsClient.RequestOptions,
): HttpResponsePromise<GetOrganizationDiscoveryDomainResponseContent>
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.
ID of the organization.
ID of the discovery domain.
OptionalrequestOptions: DiscoveryDomainsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.discoveryDomains.get("id", "discovery_domain_id")Copy
delete(
id: string,
discovery_domain_id: string,
requestOptions?: DiscoveryDomainsClient.RequestOptions,
): HttpResponsePromise<void>
Remove a discovery domain from an organization. This action cannot be undone.
ID of the organization.
ID of the discovery domain.
OptionalrequestOptions: DiscoveryDomainsClient.RequestOptionsRequest-specific configuration.
Management.TooManyRequestsError
await client.organizations.discoveryDomains.delete("id", "discovery_domain_id")Copy
update(
id: string,
discovery_domain_id: string,
request?: UpdateOrganizationDiscoveryDomainRequestContent,
requestOptions?: DiscoveryDomainsClient.RequestOptions,
): HttpResponsePromise<UpdateOrganizationDiscoveryDomainResponseContent>
Update the verification status and/or use_for_organization_discovery for an organization discovery domain. The status field must be either pending or verified. The use_for_organization_discovery field can be true or false (default: true).
ID of the organization.
ID of the discovery domain to update.
OptionalrequestOptions: DiscoveryDomainsClient.RequestOptionsRequest-specific configuration.
await client.organizations.discoveryDomains.update("id", "discovery_domain_id")Copy
Protected Readonly_options_options: NormalizedClientOptionsWithAuth<BaseClientOptions>
Member Visibility
ThemeOSLightDark
Constructors constructor Methods listcreategetByNamegetdeleteupdate Properties _options