Class UserBlocksClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class UserBlocksClient : IUserBlocksClient

Inheritance

object

UserBlocksClient

Implements

IUserBlocksClient

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

DeleteAsync(string, RequestOptions?, CancellationToken)

Remove all Brute-force Protection blocks for the user with the given ID.

Note: This endpoint does not unblock users that were blocked by a tenant administrator.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

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

DeleteByIdentifierAsync(DeleteUserBlocksByIdentifierRequestParameters, RequestOptions?, CancellationToken)

Remove all Brute-force Protection blocks for the user with the given identifier (username, phone number, or email).

Note: This endpoint does not unblock users that were blocked by a tenant administrator.

public Task DeleteByIdentifierAsync(DeleteUserBlocksByIdentifierRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request DeleteUserBlocksByIdentifierRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.UserBlocks.DeleteByIdentifierAsync(
    new DeleteUserBlocksByIdentifierRequestParameters { Identifier = "identifier" }
);

ListAsync(string, ListUserBlocksRequestParameters, RequestOptions?, CancellationToken)

Retrieve details of all Brute-force Protection blocks for the user with the given ID.

public WithRawResponseTask<ListUserBlocksResponseContent> ListAsync(string id, ListUserBlocksRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request ListUserBlocksRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<ListUserBlocksResponseContent>

Examples

await client.UserBlocks.ListAsync(
    "id",
    new ListUserBlocksRequestParameters { ConsiderBruteForceEnablement = true }
);

ListByIdentifierAsync(ListUserBlocksByIdentifierRequestParameters, RequestOptions?, CancellationToken)

Retrieve details of all Brute-force Protection blocks for a user with the given identifier (username, phone number, or email).

public WithRawResponseTask<ListUserBlocksByIdentifierResponseContent> ListByIdentifierAsync(ListUserBlocksByIdentifierRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListUserBlocksByIdentifierRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<ListUserBlocksByIdentifierResponseContent>

Examples

await client.UserBlocks.ListByIdentifierAsync(
    new ListUserBlocksByIdentifierRequestParameters
    {
        Identifier = "identifier",
        ConsiderBruteForceEnablement = true,
    }
);