• management
• SDK
• ScimConfigurationClient

Class ScimConfigurationClient

Index

Accessors

tokens

Constructors

constructor

Methods

listgetcreatedeleteupdategetDefaultMapping

Properties

_options_tokens

Accessors

tokens

get tokens(): TokensClient

Returns TokensClient

Constructors

constructor

new ScimConfigurationClient(options: BaseClientOptions): ScimConfigurationClient

Parameters

• options: BaseClientOptions

Returns ScimConfigurationClient

Methods

list

list(
request?: ListScimConfigurationsRequestParameters,
requestOptions?: ScimConfigurationClient.RequestOptions,
): Promise<Page<ScimConfiguration, ListScimConfigurationsResponseContent>>

Retrieve a list of SCIM configurations of a tenant.

Parameters

• request: ListScimConfigurationsRequestParameters = {}
• OptionalrequestOptions: ScimConfigurationClient.RequestOptions

Request-specific configuration.

Returns Promise<Page<ScimConfiguration, ListScimConfigurationsResponseContent>>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

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

get

get(
id: string,
requestOptions?: ScimConfigurationClient.RequestOptions,
): HttpResponsePromise<GetScimConfigurationResponseContent>

Retrieves a scim configuration by its connectionId.

Parameters

• id: string

The id of the connection to retrieve its SCIM configuration

• OptionalrequestOptions: ScimConfigurationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetScimConfigurationResponseContent>

Throws

Management.BadRequestError

Throws

Management.NotFoundError

Example

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

create

create(
id: string,
request?: CreateScimConfigurationRequestContent | null,
requestOptions?: ScimConfigurationClient.RequestOptions,
): HttpResponsePromise<CreateScimConfigurationResponseContent>

Create a scim configuration for a connection.

Parameters

• id: string

The id of the connection to create its SCIM configuration

• Optionalrequest: CreateScimConfigurationRequestContent | null
• OptionalrequestOptions: ScimConfigurationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<CreateScimConfigurationResponseContent>

Throws

Management.BadRequestError

Throws

Management.NotFoundError

Example

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

delete

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

Deletes a scim configuration by its connectionId.

Parameters

• id: string

The id of the connection to delete its SCIM configuration

• OptionalrequestOptions: ScimConfigurationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.BadRequestError

Throws

Management.NotFoundError

Example

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

update

update(
id: string,
request: UpdateScimConfigurationRequestContent,
requestOptions?: ScimConfigurationClient.RequestOptions,
): HttpResponsePromise<UpdateScimConfigurationResponseContent>

Update a scim configuration by its connectionId.

Parameters

• id: string

The id of the connection to update its SCIM configuration

• request: UpdateScimConfigurationRequestContent
• OptionalrequestOptions: ScimConfigurationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<UpdateScimConfigurationResponseContent>

Throws

Management.BadRequestError

Throws

Management.NotFoundError

Example

await client.connections.scimConfiguration.update("id", { user_id_attribute: "user_id_attribute", mapping: [{}] })Copy

getDefaultMapping

getDefaultMapping(
id: string,
requestOptions?: ScimConfigurationClient.RequestOptions,
): HttpResponsePromise<GetScimConfigurationDefaultMappingResponseContent>

Retrieves a scim configuration's default mapping by its connectionId.

Parameters

• id: string

The id of the connection to retrieve its default SCIM mapping

• OptionalrequestOptions: ScimConfigurationClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetScimConfigurationDefaultMappingResponseContent>

Throws

Management.BadRequestError

Throws

Management.NotFoundError

Example

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

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Protected_tokens

_tokens: TokensClient | undefined

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Accessors tokens Constructors constructor Methods listgetcreatedeleteupdategetDefaultMapping Properties _options_tokens