Get a user's blocks

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

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

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.ListUserBlocksRequestParameters{
        ConsiderBruteForceEnablement: management.Bool(
            true,
        ),
    }
    client.UserBlocks.List(
        context.TODO(),
        "id",
        request,
    )
}

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.

Path Parameters

id · string · required

user_id of the user blocks to retrieve.

Query Parameters

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 block 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