Class ConnectionsManager

Retrieves the status of an ad/ldap connection referenced by its ID. 200 OK http status code response is returned when the connection is online, otherwise a 404 status code is returned along with an error message Check connection status

Throws

Creates a new connection according to the JSON object received in body.

Create a connection

Throws

Create a scim configuration for a connection.

Create a SCIM configuration

Throws

Create a scim token for a scim client.

Create a SCIM Token

Throws

Deletes a connection and all its users.

Delete a connection

Throws

Deletes a scim configuration by its connectionId.

Delete a connection's SCIM configuration

Throws

Deletes a scim token by its connection id and tokenId.

Delete a connection's SCIM token

Throws

Deletes a specified connection user by its email (you cannot delete all users from specific connection). Currently, only Database Connections are supported.

Delete a connection user

Throws

Retrieve details for a specified connection along with options that can be used for identity provider configuration. Get a connection

Throws

Retrieves detailed list of all connections that match the specified strategy. If no strategy is provided, all connections within your tenant are retrieved. This action can accept a list of fields to include or exclude from the resulting list of connections.

This endpoint supports two types of pagination:

• Offset pagination
• Checkpoint pagination

Checkpoint pagination must be used if you need to retrieve more than 1000 connections.

Checkpoint Pagination

To search by checkpoint, use the following parameters:

• from: Optional id from which to start selection.
• take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.

Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.

Get all connections

Throws

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

Get a connection's default SCIM mapping

Throws

Retrieves a scim configuration by its connectionId.

Get a connection's SCIM configuration

Throws

Retrieves all scim tokens by its connection id.

Get a connection's SCIM tokens

Throws

Update details for a specific connection, including option properties for identity provider configuration.

Note: If you use the options parameter, the entire options object is overriden. To avoid partial data or other issues, ensure all parameters are present when using this option. Update a connection

Throws

Update a scim configuration by its connectionId.

Patch a connection's SCIM configuration

Throws