Get blocks by identifier

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

GET https://{tenantDomain}/api/v2/user-blocks

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

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

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v2/management"
    client "github.com/auth0/go-auth0/v2/management/client"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.ListUserBlocksByIdentifierRequestParameters{
        Identifier: "identifier",
        ConsiderBruteForceEnablement: management.Bool(
            true,
        ),
    }
    mgmt.UserBlocks.ListByIdentifier(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ListUserBlocksByIdentifierRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.userBlocks().listByIdentifier(
            ListUserBlocksByIdentifierRequestParameters
                .builder()
                .identifier("identifier")
                .considerBruteForceEnablement(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\UserBlocks\Requests\ListUserBlocksByIdentifierRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->userBlocks->listByIdentifier(
    new ListUserBlocksByIdentifierRequestParameters([
        'identifier' => 'identifier',
        'considerBruteForceEnablement' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.user_blocks.list_by_identifier(
    identifier="identifier",
    consider_brute_force_enablement=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.user_blocks.list_by_identifier(
  identifier: "identifier",
  consider_brute_force_enablement: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.userBlocks.listByIdentifier({
        identifier: "identifier",
        considerBruteForceEnablement: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.userBlocks.listByIdentifier({
        identifier: "identifier",
        considerBruteForceEnablement: true,
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/user-blocks \
  --header 'Authorization: Bearer <token>'

200

{
  "blocked_for": [
    {
      "identifier": "[e-mail]",
      "ip": "10.0.0.1",
      "connection": "<string>"
    }
  ]
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

identifier · string · required

Should be any of a username, phone number, or email.

consider_brute_force_enablement · boolean

If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses.
      If true and Brute Force Protection is disabled, will return an empty list.

Response

200

application/json

User successfully retrieved.

blocked_for · object[]

Array of identifier + IP address pairs. IP address is optional, and may be omitted in certain circumstances (such as Account Lockout mode).

Show child attributes