Class EnabledConnectionsClient

Namespace

Auth0.ManagementApi.Organizations

Assembly

Auth0.ManagementApi.dll

public class EnabledConnectionsClient : IEnabledConnectionsClient

Inheritance

object

EnabledConnectionsClient

Implements

IEnabledConnectionsClient

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

AddAsync(string, AddOrganizationConnectionRequestContent, RequestOptions?, CancellationToken)

Enable a specific connection for a given Organization. To enable a connection, it must already exist within your tenant; connections cannot be created through this action.

Connections represent the relationship between Auth0 and a source of users. Available types of connections include database, enterprise, and social.

public WithRawResponseTask<AddOrganizationConnectionResponseContent> AddAsync(string id, AddOrganizationConnectionRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request AddOrganizationConnectionRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<AddOrganizationConnectionResponseContent>

Examples

await client.Organizations.EnabledConnections.AddAsync(
    "id",
    new AddOrganizationConnectionRequestContent { ConnectionId = "connection_id" }
);

DeleteAsync(string, string, RequestOptions?, CancellationToken)

Disable a specific connection for an Organization. Once disabled, Organization members can no longer use that connection to authenticate.

Note: This action does not remove the connection from your tenant.

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

Parameters

id string

connectionId string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Organizations.EnabledConnections.DeleteAsync("id", "connectionId");

GetAsync(string, string, RequestOptions?, CancellationToken)

Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.

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

Parameters

id string

connectionId string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetOrganizationConnectionResponseContent>

Examples

await client.Organizations.EnabledConnections.GetAsync("id", "connectionId");

ListAsync(string, ListOrganizationConnectionsRequestParameters, RequestOptions?, CancellationToken)

Retrieve details about a specific connection currently enabled for an Organization. Information returned includes details such as connection ID, name, strategy, and whether the connection automatically grants membership upon login.

public Task<Pager<OrganizationConnection>> ListAsync(string id, ListOrganizationConnectionsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request ListOrganizationConnectionsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<OrganizationConnection>>

Examples

await client.Organizations.EnabledConnections.ListAsync(
    "id",
    new ListOrganizationConnectionsRequestParameters
    {
        Page = 1,
        PerPage = 1,
        IncludeTotals = true,
    }
);

UpdateAsync(string, string, UpdateOrganizationConnectionRequestContent, RequestOptions?, CancellationToken)

Modify the details of a specific connection currently enabled for an Organization.

public WithRawResponseTask<UpdateOrganizationConnectionResponseContent> UpdateAsync(string id, string connectionId, UpdateOrganizationConnectionRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

connectionId string

request UpdateOrganizationConnectionRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateOrganizationConnectionResponseContent>

Examples

await client.Organizations.EnabledConnections.UpdateAsync(
    "id",
    "connectionId",
    new UpdateOrganizationConnectionRequestContent()
);