Class ScimConfigurationClient

Index

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
    })
```

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")
```

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

Throws
Management.ConflictError
Example
```
await client.connections.scimConfiguration.create("id")
```

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")
```

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: [{}]
    })
```

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")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_tokens

_tokens: TokensClient | undefined

Class ScimConfigurationClient

Index

Accessors

Constructors

Methods

Properties

Accessors

tokens

Returns TokensClient

Constructors

constructor

Parameters

Returns ScimConfigurationClient

Methods

list

Parameters

Returns Promise<Page<ScimConfiguration, ListScimConfigurationsResponseContent>>

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetScimConfigurationResponseContent>

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateScimConfigurationResponseContent>

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

Throws

Example

update

Parameters

Returns HttpResponsePromise<UpdateScimConfigurationResponseContent>

Throws

Throws

Example

getDefaultMapping

Parameters

Returns HttpResponsePromise<GetScimConfigurationDefaultMappingResponseContent>

Throws

Throws

Example

Properties

Protected Readonly_options

Protected_tokens

Settings

On This Page

`Protected` `Readonly`_options

`Protected`_tokens