Back to Node Auth0

Class DirectoryProvisioningClient

docs/classes/management.SDK.DirectoryProvisioningClient.html

5.9.115.9 KB
Original Source

Class DirectoryProvisioningClient

Index

Accessors

synchronizations

Constructors

constructor

Methods

listgetcreatedeleteupdategetDefaultMappinglistSynchronizedGroupsset

Properties

_options_synchronizations

Accessors

synchronizations

get synchronizations(): SynchronizationsClient

Returns SynchronizationsClient

Constructors

constructor

new DirectoryProvisioningClient(
options: BaseClientOptions,
): DirectoryProvisioningClient

Parameters

Returns DirectoryProvisioningClient

Methods

list

list(
request?: ListDirectoryProvisioningsRequestParameters,
requestOptions?: DirectoryProvisioningClient.RequestOptions,
): Promise<
Page<DirectoryProvisioning, ListDirectoryProvisioningsResponseContent>,
>

Retrieve a list of directory provisioning configurations of a tenant.

Parameters

Request-specific configuration.

Returns Promise<Page<DirectoryProvisioning, ListDirectoryProvisioningsResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.connections.directoryProvisioning.list({ from: "from", take: 1 })Copy

get

get(
id: string,
requestOptions?: DirectoryProvisioningClient.RequestOptions,
): HttpResponsePromise<GetDirectoryProvisioningResponseContent>

Retrieve the directory provisioning configuration of a connection.

Parameters

  • id: string

The id of the connection to retrieve its directory provisioning configuration

Request-specific configuration.

Returns HttpResponsePromise<GetDirectoryProvisioningResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.connections.directoryProvisioning.get("id")Copy

create

create(
id: string,
request?: CreateDirectoryProvisioningRequestContent | null,
requestOptions?: DirectoryProvisioningClient.RequestOptions,
): HttpResponsePromise<CreateDirectoryProvisioningResponseContent>

Create a directory provisioning configuration for a connection.

Parameters

  • id: string

The id of the connection to create its directory provisioning configuration

Request-specific configuration.

Returns HttpResponsePromise<CreateDirectoryProvisioningResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.connections.directoryProvisioning.create("id")Copy

delete

delete(
id: string,
requestOptions?: DirectoryProvisioningClient.RequestOptions,
): HttpResponsePromise<void>

Delete the directory provisioning configuration of a connection.

Parameters

  • id: string

The id of the connection to delete its directory provisioning configuration

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.connections.directoryProvisioning.delete("id")Copy

update

update(
id: string,
request?: UpdateDirectoryProvisioningRequestContent | null,
requestOptions?: DirectoryProvisioningClient.RequestOptions,
): HttpResponsePromise<UpdateDirectoryProvisioningResponseContent>

Update the directory provisioning configuration of a connection.

Parameters

  • id: string

The id of the connection to create its directory provisioning configuration

Request-specific configuration.

Returns HttpResponsePromise<UpdateDirectoryProvisioningResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.connections.directoryProvisioning.update("id")Copy

getDefaultMapping

getDefaultMapping(
id: string,
requestOptions?: DirectoryProvisioningClient.RequestOptions,
): HttpResponsePromise<
GetDirectoryProvisioningDefaultMappingResponseContent,
>

Retrieve the directory provisioning default attribute mapping of a connection.

Parameters

  • id: string

The id of the connection to retrieve its directory provisioning configuration

Request-specific configuration.

Returns HttpResponsePromise<GetDirectoryProvisioningDefaultMappingResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.connections.directoryProvisioning.getDefaultMapping("id")Copy

listSynchronizedGroups

listSynchronizedGroups(
id: string,
request?: ListSynchronizedGroupsRequestParameters,
requestOptions?: DirectoryProvisioningClient.RequestOptions,
): Promise<
Page<SynchronizedGroupPayload, ListSynchronizedGroupsResponseContent>,
>

Retrieve the configured synchronized groups for a connection directory provisioning configuration.

Parameters

  • id: string

The id of the connection to list synchronized groups for.

Request-specific configuration.

Returns Promise<Page<SynchronizedGroupPayload, ListSynchronizedGroupsResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.connections.directoryProvisioning.listSynchronizedGroups("id", { from: "from", take: 1 })Copy

set

set(
id: string,
request: ReplaceSynchronizedGroupsRequestContent,
requestOptions?: DirectoryProvisioningClient.RequestOptions,
): HttpResponsePromise<void>

Create or replace the selected groups for a connection directory provisioning configuration.

Parameters

  • id: string

The id of the connection to create or replace synchronized groups for

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.ConflictError

Throws

Management.TooManyRequestsError

Example

await client.connections.directoryProvisioning.set("id", { groups: [{ id: "id" }] })Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Protected_synchronizations

_synchronizations: SynchronizationsClient | undefined

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Accessors synchronizations Constructors constructor Methods listgetcreatedeleteupdategetDefaultMappinglistSynchronizedGroupsset Properties _options_synchronizations