Class DirectoryProvisioningClient

Index

Accessors

Constructors

Methods

list get create delete update getDefaultMapping listSynchronizedGroups addSynchronizedGroupSelections set deleteSynchronizedGroupSelections

Properties

_options _synchronizations

Accessors

synchronizations

get synchronizations(): SynchronizationsClient

Returns SynchronizationsClient

Constructors

constructor

new DirectoryProvisioningClient(
options: BaseClientOptions,
): DirectoryProvisioningClient
Parameters
- options: BaseClientOptions
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: ListDirectoryProvisioningsRequestParameters = {}
- OptionalrequestOptions: DirectoryProvisioningClient.RequestOptions
  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
    })
```

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
- OptionalrequestOptions: DirectoryProvisioningClient.RequestOptions
  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")
```

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
- Optionalrequest: CreateDirectoryProvisioningRequestContent | null
- OptionalrequestOptions: DirectoryProvisioningClient.RequestOptions
  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")
```

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
- OptionalrequestOptions: DirectoryProvisioningClient.RequestOptions
  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")
```

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
- Optionalrequest: UpdateDirectoryProvisioningRequestContent | null
- OptionalrequestOptions: DirectoryProvisioningClient.RequestOptions
  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")
```

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
- OptionalrequestOptions: DirectoryProvisioningClient.RequestOptions
  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")
```

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: ListSynchronizedGroupsRequestParameters = {}
- OptionalrequestOptions: DirectoryProvisioningClient.RequestOptions
  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,
        q: "q"
    })
```

addSynchronizedGroupSelections

addSynchronizedGroupSelections(
    id: string,
    request: AddSynchronizedGroupsRequestContent,
    requestOptions?: DirectoryProvisioningClient.RequestOptions,
): HttpResponsePromise<void>
Add synchronized group selections to a directory provisioning configuration.
Parameters
- id: string
  The id of the connection to add synchronized groups to
- request: AddSynchronizedGroupsRequestContent
- OptionalrequestOptions: DirectoryProvisioningClient.RequestOptions
  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.addSynchronizedGroupSelections("id", {
        groups: [{
                id: "id"
            }]
    })
```

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: ReplaceSynchronizedGroupsRequestContent
- OptionalrequestOptions: DirectoryProvisioningClient.RequestOptions
  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"
            }]
    })
```

deleteSynchronizedGroupSelections

deleteSynchronizedGroupSelections(
    id: string,
    request: DeleteSynchronizedGroupsRequestContent,
    requestOptions?: DirectoryProvisioningClient.RequestOptions,
): HttpResponsePromise<void>
Delete synchronized group selections for a directory provisioning configuration
Parameters
- id: string
  The id of the connection to delete synchronized group selections for
- request: DeleteSynchronizedGroupsRequestContent
- OptionalrequestOptions: DirectoryProvisioningClient.RequestOptions
  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.deleteSynchronizedGroupSelections("id", {
        groups: [{
                id: "id"
            }]
    })
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_synchronizations

_synchronizations: SynchronizationsClient | undefined

Class DirectoryProvisioningClient

Index

Accessors

Constructors

Methods

Properties

Accessors

synchronizations

Returns SynchronizationsClient

Constructors

constructor

Parameters

Returns DirectoryProvisioningClient

Methods

list

Parameters

Returns Promise<Page<DirectoryProvisioning, ListDirectoryProvisioningsResponseContent>>

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetDirectoryProvisioningResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateDirectoryProvisioningResponseContent>

Throws

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Throws

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateDirectoryProvisioningResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

getDefaultMapping

Parameters

Returns HttpResponsePromise<GetDirectoryProvisioningDefaultMappingResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

listSynchronizedGroups

Parameters

Returns Promise<Page<SynchronizedGroupPayload, ListSynchronizedGroupsResponseContent>>

Throws

Throws

Throws

Throws

Throws

Example

addSynchronizedGroupSelections

Parameters

Returns HttpResponsePromise<void>

`Protected` `Readonly`_options

`Protected`_synchronizations