Table of Contents

Interface IConnectionsClient

Namespace
Auth0.ManagementApi.Clients
Assembly
Auth0.ManagementApi.dll
public interface IConnectionsClient

Methods

CheckStatusAsync(string, CancellationToken)

Retrieves the status of an ad/ldap connection.

Task CheckStatusAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

ID of the connection to check.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

A Task that represents the asynchronous check operation. Will throw if the status check fails.

CreateAsync(ConnectionCreateRequest, CancellationToken)

Creates a new connection according to the request.

Task<Connection> CreateAsync(ConnectionCreateRequest request, CancellationToken cancellationToken = default)

Parameters

request ConnectionCreateRequest

The request containing the properties for the new connection.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<Connection>

A Connection containing the newly created Connection.

CreateScimConfigurationAsync(string, ScimConfigurationCreateRequest, CancellationToken)

Creates an ScimConfiguration.

Task<ScimConfiguration> CreateScimConfigurationAsync(string id, ScimConfigurationCreateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to create an ScimConfiguration

request ScimConfigurationCreateRequest

ScimConfigurationCreateRequest containing information required for creating an ScimConfiguration

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<ScimConfiguration>

A ScimConfiguration.

CreateScimTokenAsync(string, ScimTokenCreateRequest, CancellationToken)

Creates an ScimToken.

Task<ScimTokenCreateResponse> CreateScimTokenAsync(string id, ScimTokenCreateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to create an ScimToken

request ScimTokenCreateRequest

ScimTokenCreateRequest containing information required for creating an ScimToken

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<ScimTokenCreateResponse>

An ScimTokenCreateResponse.

DeleteAsync(string, CancellationToken)

Deletes a connection and all its users.

Task DeleteAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to delete.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

A Task that represents the asynchronous delete operation.

DeleteScimConfigurationAsync(string, CancellationToken)

Deletes an ScimConfiguration.

Task DeleteScimConfigurationAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to delete ScimConfiguration

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

DeleteScimTokenAsync(string, string, CancellationToken)

Deletes an SCIM token.

Task DeleteScimTokenAsync(string id, string tokenId, CancellationToken cancellationToken = default)

Parameters

id string

The ID of the connection that owns the ScimToken to be deleted

tokenId string

The ID of the ScimToken to delete

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

DeleteUserAsync(string, string, CancellationToken)

Deletes a specified connection user by its email.

Task DeleteUserAsync(string id, string email, CancellationToken cancellationToken = default)

Parameters

id string

The identifier of the connection.

email string

The email of the user to delete.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

A Task that represents the asynchronous delete operation.

Remarks

Currently only database connections are supported and you cannot delete all users from specific connection.

GetAllAsync(GetConnectionsRequest, CheckpointPaginationInfo, CancellationToken)

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.

Task<ICheckpointPagedList<Connection>> GetAllAsync(GetConnectionsRequest request, CheckpointPaginationInfo pagination = null, CancellationToken cancellationToken = default)

Parameters

request GetConnectionsRequest

Specifies criteria to use when querying connections.

pagination CheckpointPaginationInfo

Specifies the CheckPoint Pagination info CheckpointPaginationInfo

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<ICheckpointPagedList<Connection>>

An ICheckpointPagedList<T> containing the list of connections.

GetAllAsync(GetConnectionsRequest, PaginationInfo, CancellationToken)

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.

Task<IPagedList<Connection>> GetAllAsync(GetConnectionsRequest request, PaginationInfo pagination = null, CancellationToken cancellationToken = default)

Parameters

request GetConnectionsRequest

Specifies criteria to use when querying connections.

pagination PaginationInfo

Specifies pagination info to use when requesting paged results.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<IPagedList<Connection>>

An IPagedList<T> containing the list of connections.

GetAsync(string, string, bool, CancellationToken)

Retrieves a connection by its id.

Task<Connection> GetAsync(string id, string fields = null, bool includeFields = true, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to retrieve.

fields string

A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields.

includeFields bool

True if the fields specified are to be included in the result, false otherwise (defaults to true).

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<Connection>

The Connection.

GetDefaultScimMappingAsync(string, CancellationToken)

Retrieves the default ScimMapping.

Task<IList<ScimMapping>> GetDefaultScimMappingAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to retrieve its default ScimMapping

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<IList<ScimMapping>>

An IList of ScimMapping.

GetEnabledClientsAsync(EnabledClientsGetRequest, CheckpointPaginationInfo?, CancellationToken)

Retrieves a ICheckpointPagedList list of enabled clients for a connection.

Task<ICheckpointPagedList<EnabledClients>> GetEnabledClientsAsync(EnabledClientsGetRequest request, CheckpointPaginationInfo? pagination = null, CancellationToken cancellationToken = default)

Parameters

request EnabledClientsGetRequest

The request containing criteria for retrieving enabled clients.

pagination CheckpointPaginationInfo

The checkpoint pagination information to use for paged results.

cancellationToken CancellationToken

The cancellation token to cancel the operation.

Returns

Task<ICheckpointPagedList<EnabledClients>>

An ICheckpointPagedList<T> containing the list of enabled clients.

GetScimConfigurationAsync(string, CancellationToken)

Retrieves an ScimConfiguration.

Task<ScimConfiguration> GetScimConfigurationAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to retrieve its ScimConfiguration

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<ScimConfiguration>

A ScimConfiguration.

GetScimTokenAsync(string, CancellationToken)

Retrieves all ScimToken for the given connection.

Task<IList<ScimToken>> GetScimTokenAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to retrieve its ScimToken

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<IList<ScimToken>>

An ScimToken.

UpdateAsync(string, ConnectionUpdateRequest, CancellationToken)

Updates a connection.

Task<Connection> UpdateAsync(string id, ConnectionUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to update.

request ConnectionUpdateRequest

The ConnectionUpdateRequest containing the properties of the connection you wish to update.

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<Connection>

The Connection that has been updated.

UpdateEnabledClientsAsync(string, EnabledClientsUpdateRequest, CancellationToken)

Updates the list of enabled clients for a connection.

Task UpdateEnabledClientsAsync(string id, EnabledClientsUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

The ID of the connection to update enabled clients for.

request EnabledClientsUpdateRequest

The request containing the updated list of enabled clients.

cancellationToken CancellationToken

The cancellation token to cancel the operation.

Returns

Task

UpdateScimConfigurationAsync(string, ScimConfigurationUpdateRequest, CancellationToken)

Updates an ScimConfiguration.

Task<ScimConfiguration> UpdateScimConfigurationAsync(string id, ScimConfigurationUpdateRequest request, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to update ScimConfiguration

request ScimConfigurationUpdateRequest

ScimConfigurationUpdateRequest containing information required for updating an ScimConfiguration

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<ScimConfiguration>

A ScimConfiguration.