Class DiscoveryDomainsClient

Index

Constructors

constructor

new DiscoveryDomainsClient(options: BaseClientOptions): DiscoveryDomainsClient
Parameters
- options: BaseClientOptions
Returns DiscoveryDomainsClient

Methods

list

list(
    id: string,
    request?: ListOrganizationDiscoveryDomainsRequestParameters,
    requestOptions?: DiscoveryDomainsClient.RequestOptions,
): Promise<
    Page<
        OrganizationDiscoveryDomain,
        ListOrganizationDiscoveryDomainsResponseContent,
    >,
>
Retrieve list of all organization discovery domains associated with the specified organization.
Parameters
- id: string
  ID of the organization.
- request: ListOrganizationDiscoveryDomainsRequestParameters = {}
- OptionalrequestOptions: DiscoveryDomainsClient.RequestOptions
  Request-specific configuration.
Returns Promise<
    Page<
        OrganizationDiscoveryDomain,
        ListOrganizationDiscoveryDomainsResponseContent,
    >,
>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.discoveryDomains.list("id", {
        from: "from",
        take: 1
    })
```

create

create(
    id: string,
    request: CreateOrganizationDiscoveryDomainRequestContent,
    requestOptions?: DiscoveryDomainsClient.RequestOptions,
): HttpResponsePromise<CreateOrganizationDiscoveryDomainResponseContent>
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).
Parameters
- id: string
  ID of the organization.
- request: CreateOrganizationDiscoveryDomainRequestContent
- OptionalrequestOptions: DiscoveryDomainsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateOrganizationDiscoveryDomainResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.discoveryDomains.create("id", {
        domain: "domain"
    })
```

get

get(
    id: string,
    discovery_domain_id: string,
    requestOptions?: DiscoveryDomainsClient.RequestOptions,
): HttpResponsePromise<GetOrganizationDiscoveryDomainResponseContent>
Retrieve details about a single organization discovery domain specified by ID.
Parameters
- id: string
  ID of the organization.
- discovery_domain_id: string
  ID of the discovery domain.
- OptionalrequestOptions: DiscoveryDomainsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetOrganizationDiscoveryDomainResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.discoveryDomains.get("id", "discovery_domain_id")
```

delete

delete(
    id: string,
    discovery_domain_id: string,
    requestOptions?: DiscoveryDomainsClient.RequestOptions,
): HttpResponsePromise<void>
Remove a discovery domain from an organization. This action cannot be undone.
Parameters
- id: string
  ID of the organization.
- discovery_domain_id: string
  ID of the discovery domain.
- OptionalrequestOptions: DiscoveryDomainsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.discoveryDomains.delete("id", "discovery_domain_id")
```

update

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).
Parameters
- id: string
  ID of the organization.
- discovery_domain_id: string
  ID of the discovery domain to update.
- request: UpdateOrganizationDiscoveryDomainRequestContent = {}
- OptionalrequestOptions: DiscoveryDomainsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateOrganizationDiscoveryDomainResponseContent>
Throws
Management.BadRequestError

Throws
Management.NotFoundError
Example
```
await client.organizations.discoveryDomains.update("id", "discovery_domain_id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Class DiscoveryDomainsClient

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns DiscoveryDomainsClient

Methods

list

Parameters

Returns Promise< Page< OrganizationDiscoveryDomain, ListOrganizationDiscoveryDomainsResponseContent, >,>

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateOrganizationDiscoveryDomainResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetOrganizationDiscoveryDomainResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateOrganizationDiscoveryDomainResponseContent>

Throws

Throws

Example

Properties

Protected Readonly_options

Settings

On This Page

Returns Promise<
Page<
OrganizationDiscoveryDomain,
ListOrganizationDiscoveryDomainsResponseContent,
>,
>

`Protected` `Readonly`_options