Class ConnectionsClient

Namespace

Auth0.ManagementApi.Clients

Assembly

Auth0.ManagementApi.dll

Contains methods to access the /connections endpoints.

public class ConnectionsClient : BaseClient, IConnectionsClient

Inheritance

object

BaseClient

ConnectionsClient

Implements

IConnectionsClient

Inherited Members

BaseClient.Connection

BaseClient.BaseUri

BaseClient.DefaultHeaders

BaseClient.BuildUri(string, IDictionary<string, string>)

BaseClient.BuildUri(string, IList<Tuple<string, string>>)

BaseClient.EncodePath(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConnectionsClient(IManagementConnection, Uri, IDictionary<string, string>)

Initializes a new instance of the ConnectionsClient.

public ConnectionsClient(IManagementConnection connection, Uri baseUri, IDictionary<string, string> defaultHeaders)

Parameters

connection IManagementConnection

IManagementConnection used to make all API calls.

baseUri Uri

Uri of the endpoint to use in making API calls.

defaultHeaders IDictionary<string, string>

Dictionary containing default headers included with every request this client makes.

Methods

CheckStatusAsync(string, CancellationToken)

Retrieves the status of an ad/ldap connection.

public 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 check fails.

CreateAsync(ConnectionCreateRequest, CancellationToken)

Creates a new connection according to the request.

public 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.

public 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.

public 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.

public 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.

public Task DeleteScimConfigurationAsync(string id, CancellationToken cancellationToken = default)

Parameters

id string

The id of the connection to delete its SCIM configuration

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task

DeleteScimTokenAsync(string, string, CancellationToken)

Deletes an SCIM token.

public 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.

public 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.

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

Parameters

request GetConnectionsRequest

GetConnectionsRequest

pagination CheckpointPaginationInfo

CheckpointPaginationInfo

cancellationToken CancellationToken

CancellationToken

Returns

Task<ICheckpointPagedList<Connection>>

List of Connection

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.

public 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.

public 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.

public 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.

public 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.

public 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.

public 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.

public 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.

public 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 ScimConfigurationn.

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

Parameters

id string

The id of the connection to update its SCIM configuration

request ScimConfigurationUpdateRequest

ScimConfigurationUpdateRequest containing information required for updating an ScimConfiguration

cancellationToken CancellationToken

The cancellation token to cancel operation.

Returns

Task<ScimConfiguration>

A ScimConfiguration.