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

Deletes a connection and all its users.

Delete a connection

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

Retrieves a connection by its ID.

Get a connection

Throws

Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects. This endpoint supports two types of pagination:

• Offset pagination
• Checkpoint pagination

Checkpoint pagination should 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.

The first time you call this endpoint using Checkpoint Pagination, you should omit the from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.

Note: The include_totals parameter is not supported when using checkpoint pagination. Get all connections

Throws

Note: if you use the options parameter, the whole options object will be overridden, so ensure that all parameters are present

Update a connection

Throws