{
  "opencollection": "1.0.0",
  "info": {
    "name": "Auth0 Authentication actions user-blocks API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "user-blocks",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Blocks by Identifier",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/user-blocks",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "query",
                "description": "Should be any of a username, phone number, or email."
              },
              {
                "name": "consider_brute_force_enablement",
                "value": "",
                "type": "query",
                "description": "\n          If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses.\n          If true and Brute Force Protection is disabled, will return an empty list.\n        "
              }
            ]
          },
          "docs": "Retrieve details of all <a href=\"https://auth0.com/docs/secure/attack-protection/brute-force-protection\">Brute-force Protection</a> blocks for a user with the given identifier (username, phone number, or email)."
        },
        {
          "info": {
            "name": "Unblock by Identifier",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{auth0_domain}/user-blocks",
            "params": [
              {
                "name": "identifier",
                "value": "",
                "type": "query",
                "description": "Should be any of a username, phone number, or email."
              }
            ]
          },
          "docs": "Remove all <a href=\"https://auth0.com/docs/secure/attack-protection/brute-force-protection\">Brute-force Protection</a> blocks for the user with the given identifier (username, phone number, or email).\n\nNote: This endpoint does not unblock users that were <a href=\"https://auth0.com/docs/user-profile#block-and-unblock-a-user\">blocked by a tenant administrator</a>.\n"
        },
        {
          "info": {
            "name": "Get a User's Blocks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{auth0_domain}/user-blocks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "user_id of the user blocks to retrieve."
              },
              {
                "name": "consider_brute_force_enablement",
                "value": "",
                "type": "query",
                "description": "\n          If true and Brute Force Protection is enabled and configured to block logins, will return a list of blocked IP addresses.\n          If true and Brute Force Protection is disabled, will return an empty list.\n        "
              }
            ]
          },
          "docs": "Retrieve details of all <a href=\"https://auth0.com/docs/secure/attack-protection/brute-force-protection\">Brute-force Protection</a> blocks for the user with the given ID.\n"
        },
        {
          "info": {
            "name": "Unblock a User",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{auth0_domain}/user-blocks/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The user_id of the user to update."
              }
            ]
          },
          "docs": "Remove all <a href=\"https://auth0.com/docs/secure/attack-protection/brute-force-protection\">Brute-force Protection</a> blocks for the user with the given ID.\n\nNote: This endpoint does not unblock users that were <a href=\"https://auth0.com/docs/user-profile#block-and-unblock-a-user\">blocked by a tenant administrator</a>.\n"
        }
      ]
    }
  ],
  "bundled": true
}