Class AuthenticationMethodsClient

Namespace

Auth0.ManagementApi.Users

Assembly

Auth0.ManagementApi.dll

public class AuthenticationMethodsClient : IAuthenticationMethodsClient

Inheritance

object

AuthenticationMethodsClient

Implements

IAuthenticationMethodsClient

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(string, CreateUserAuthenticationMethodRequestContent, RequestOptions?, CancellationToken)

Create an authentication method. Authentication methods created via this endpoint will be auto confirmed and should already have verification completed.

public WithRawResponseTask<CreateUserAuthenticationMethodResponseContent> CreateAsync(string id, CreateUserAuthenticationMethodRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request CreateUserAuthenticationMethodRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateUserAuthenticationMethodResponseContent>

Examples

await client.Users.AuthenticationMethods.CreateAsync(
    "id",
    new CreateUserAuthenticationMethodRequestContent
    {
        Type = CreatedUserAuthenticationMethodTypeEnum.Phone,
    }
);

DeleteAllAsync(string, RequestOptions?, CancellationToken)

Remove all authentication methods (i.e., enrolled MFA factors) from the specified user account. This action cannot be undone.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Users.AuthenticationMethods.DeleteAllAsync("id");

DeleteAsync(string, string, RequestOptions?, CancellationToken)

Remove the authentication method with the given ID from the specified user. For more information, review Manage Authentication Methods with Management API.

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

Parameters

id string

authenticationMethodId string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Users.AuthenticationMethods.DeleteAsync("id", "authentication_method_id");

GetAsync(string, string, RequestOptions?, CancellationToken)

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

Parameters

id string

authenticationMethodId string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetUserAuthenticationMethodResponseContent>

Examples

await client.Users.AuthenticationMethods.GetAsync("id", "authentication_method_id");

ListAsync(string, ListUserAuthenticationMethodsRequestParameters, RequestOptions?, CancellationToken)

Retrieve detailed list of authentication methods associated with a specified user.

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

Parameters

id string

request ListUserAuthenticationMethodsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<UserAuthenticationMethod>>

Examples

await client.Users.AuthenticationMethods.ListAsync(
    "id",
    new ListUserAuthenticationMethodsRequestParameters
    {
        Page = 1,
        PerPage = 1,
        IncludeTotals = true,
    }
);

SetAsync(string, IEnumerable<SetUserAuthenticationMethods>, RequestOptions?, CancellationToken)

public WithRawResponseTask<IEnumerable<SetUserAuthenticationMethodResponseContent>> SetAsync(string id, IEnumerable<SetUserAuthenticationMethods> request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request IEnumerable<SetUserAuthenticationMethods>

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<IEnumerable<SetUserAuthenticationMethodResponseContent>>

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

Modify the authentication method with the given ID from the specified user. For more information, review Manage Authentication Methods with Management API.

public WithRawResponseTask<UpdateUserAuthenticationMethodResponseContent> UpdateAsync(string id, string authenticationMethodId, UpdateUserAuthenticationMethodRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

authenticationMethodId string

request UpdateUserAuthenticationMethodRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateUserAuthenticationMethodResponseContent>

Examples

await client.Users.AuthenticationMethods.UpdateAsync(
    "id",
    "authentication_method_id",
    new UpdateUserAuthenticationMethodRequestContent()
);