Class ScimConfiguration

Index

Accessors

tokens

get tokens(): Tokens
Returns Tokens

Constructors

constructor

new ScimConfiguration(_options: ScimConfiguration.Options): ScimConfiguration
Parameters
- _options: ScimConfiguration.Options
Returns ScimConfiguration

Methods

get

get(
id: string,
requestOptions?: ScimConfiguration.RequestOptions,
): HttpResponsePromise<GetScimConfigurationResponseContent>
Retrieves a scim configuration by its connectionId.
Parameters
- id: string
  The id of the connection to retrieve its SCIM configuration
- OptionalrequestOptions: ScimConfiguration.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,
    requestOptions?: ScimConfiguration.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
- OptionalrequestOptions: ScimConfiguration.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateScimConfigurationResponseContent>
Throws
Management.BadRequestError

Throws
Management.NotFoundError
Example
```
await client.connections.scimConfiguration.create("id", undefined)
```

delete

delete(
id: string,
requestOptions?: ScimConfiguration.RequestOptions,
): HttpResponsePromise<void>
Deletes a scim configuration by its connectionId.
Parameters
- id: string
  The id of the connection to delete its SCIM configuration
- OptionalrequestOptions: ScimConfiguration.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: Management.UpdateScimConfigurationRequestContent,
    requestOptions?: ScimConfiguration.RequestOptions,
): HttpResponsePromise<UpdateScimConfigurationResponseContent>
Update a scim configuration by its connectionId.
Parameters
- id: string
  The id of the connection to update its SCIM configuration
- request: Management.UpdateScimConfigurationRequestContent
- OptionalrequestOptions: ScimConfiguration.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?: ScimConfiguration.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: ScimConfiguration.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetScimConfigurationDefaultMappingResponseContent>
Throws
Management.BadRequestError

Throws
Management.NotFoundError
Example
```
await client.connections.scimConfiguration.getDefaultMapping("id")
```

`Protected`_getAuthorizationHeader

_getAuthorizationHeader(): Promise<string>
Returns Promise<string>

Properties

`Protected` `Readonly`_options

_options: ScimConfiguration.Options

`Protected`_tokens

_tokens: undefined | Tokens

Class ScimConfiguration

Index

Accessors

Constructors

Methods

Properties

Accessors

tokens

Returns Tokens

Constructors

constructor

Parameters

Returns ScimConfiguration

Methods

get

Parameters

Returns HttpResponsePromise<GetScimConfigurationResponseContent>

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateScimConfigurationResponseContent>

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

Protected_getAuthorizationHeader

Returns Promise<string>

Properties

Protected Readonly_options

Protected_tokens

Settings

On This Page

`Protected`_getAuthorizationHeader

`Protected` `Readonly`_options

`Protected`_tokens