Passer au contenu principal
GET
/
attack-protection
/
breached-password-detection
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.attackProtection.breachedPasswordDetection.get();
}
main();
{
  "enabled": true,
  "shields": [
    "block"
  ],
  "admin_notification_frequency": [
    "immediately"
  ],
  "method": "standard",
  "stage": {
    "pre-user-registration": {
      "shields": [
        "block"
      ]
    },
    "pre-change-password": {
      "shields": [
        "block"
      ]
    }
  }
}

Autorisations

Authorization
string
header
requis

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

Réponse

Breached password detection settings successfully retrieved.

enabled
boolean
défaut:true

Whether or not breached password detection is active.

shields
enum<string>[]

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

Options disponibles:
block,
user_notification,
admin_notification
admin_notification_frequency
enum<string>[]

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

Options disponibles:
immediately,
daily,
weekly,
monthly
method
enum<string>
défaut:standard

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

Options disponibles:
standard,
enhanced
stage
object