Class ConnectionProfilesClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class ConnectionProfilesClient : IConnectionProfilesClient

Inheritance

object

ConnectionProfilesClient

Implements

IConnectionProfilesClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Methods

CreateAsync(CreateConnectionProfileRequestContent, RequestOptions?, CancellationToken)

Create a Connection Profile.

public WithRawResponseTask<CreateConnectionProfileResponseContent> CreateAsync(CreateConnectionProfileRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateConnectionProfileRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateConnectionProfileResponseContent>

Examples

await client.ConnectionProfiles.CreateAsync(
    new CreateConnectionProfileRequestContent { Name = "name" }
);

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete a single Connection Profile specified by ID.

public Task DeleteAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.ConnectionProfiles.DeleteAsync("id");

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve details about a single Connection Profile specified by ID.

public WithRawResponseTask<GetConnectionProfileResponseContent> GetAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetConnectionProfileResponseContent>

Examples

await client.ConnectionProfiles.GetAsync("id");

GetTemplateAsync(string, RequestOptions?, CancellationToken)

Retrieve a Connection Profile Template.

public WithRawResponseTask<GetConnectionProfileTemplateResponseContent> GetTemplateAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetConnectionProfileTemplateResponseContent>

Examples

await client.ConnectionProfiles.GetTemplateAsync("id");

ListAsync(ListConnectionProfileRequestParameters, RequestOptions?, CancellationToken)

Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination.

public Task<Pager<ConnectionProfile>> ListAsync(ListConnectionProfileRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListConnectionProfileRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<ConnectionProfile>>

Examples

await client.ConnectionProfiles.ListAsync(
    new ListConnectionProfileRequestParameters { From = "from", Take = 1 }
);

ListTemplatesAsync(RequestOptions?, CancellationToken)

Retrieve a list of Connection Profile Templates.

public WithRawResponseTask<ListConnectionProfileTemplateResponseContent> ListTemplatesAsync(RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<ListConnectionProfileTemplateResponseContent>

Examples

await client.ConnectionProfiles.ListTemplatesAsync();

UpdateAsync(string, UpdateConnectionProfileRequestContent, RequestOptions?, CancellationToken)

Update the details of a specific Connection Profile.

public WithRawResponseTask<UpdateConnectionProfileResponseContent> UpdateAsync(string id, UpdateConnectionProfileRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request UpdateConnectionProfileRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateConnectionProfileResponseContent>

Examples

await client.ConnectionProfiles.UpdateAsync("id", new UpdateConnectionProfileRequestContent());