Auth0 API | Attack Protection › Breached Password Detection › Update Breached Password Detection Settings

Attack Protection

attack_protection

Attack Protection

Breached Password Detection

attack_protection.breached_password_detection

Methods

Get Breached Password Detection Settings ->

BreachedPasswordDetectionSettings

get/attack-protection/breached-password-detection

Retrieve details of the Breached Password Detection configuration of your tenant.

Update Breached Password Detection Settings -> { admin_notification_frequency, enabled, method, 2 more... }

patch/attack-protection/breached-password-detection

Update details of the Breached Password Detection configuration of your tenant.

Security

Example: Authorization: Bearer My Bearer Token

Response fields

admin_notification_frequency: Array<"immediately" | "daily" | "weekly" | 1 more...>

Optional

When "admin_notification" is enabled, determines how often email notifications are sent. Possible values: immediately, daily, weekly, monthly.

enabled: boolean

Optional

Whether or not breached password detection is active.

method: "standard" | "enhanced"

Optional

The subscription level for breached password detection methods. Use "enhanced" to enable Credential Guard. Possible values: standard, enhanced.

shields: Array<"block" | "user_notification" | "admin_notification">

Optional

Action to take when a breached password is detected during a login. Possible values: block, user_notification, admin_notification.

stage: { pre-user-registration }

Optional

Request example

curl https://login0.local.dev.auth0.com/api/v2/attack-protection/breached-password-detection \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $BEARER_TOKEN"

200Example

{
  "admin_notification_frequency": [
    "immediately"
  ],
  "enabled": true,
  "method": "standard",
  "shields": [
    "block"
  ],
  "stage": {
    "pre-user-registration": {
      "shields": [
        "block"
      ]
    }
  }
}

Domain types

BreachedPasswordDetectionSettings = { admin_notification_frequency, enabled, method, 2 more... }

Attack Protection

Brute Force Protection

attack_protection.brute_force_protection

Methods

Get Brute Force Settings ->

BruteForceProtectionSettings

get/attack-protection/brute-force-protection

Retrieve details of the Brute-force Protection configuration of your tenant.

Update Brute Force Settings -> { allowlist, enabled, max_attempts, 2 more... }

patch/attack-protection/brute-force-protection

Update the Brute-force Protection configuration of your tenant.

Domain types

BruteForceProtectionSettings = { allowlist, enabled, max_attempts, 2 more... }

Attack Protection

Suspicious IP Throttling

attack_protection.suspicious_ip_throttling

Methods

Get Suspicious IP Throttling Settings ->

SuspiciousIPThrottlingSettings

get/attack-protection/suspicious-ip-throttling

Retrieve details of the Suspicious IP Throttling configuration of your tenant.

Update Suspicious IP Throttling Settings -> { allowlist, enabled, shields, 1 more... }

patch/attack-protection/suspicious-ip-throttling

Update the details of the Suspicious IP Throttling configuration of your tenant.

Domain types

SuspiciousIPThrottlingSettings = { allowlist, enabled, shields, 1 more... }