Get Breached Password Detection settings

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

GET https://{tenantDomain}/api/v2/attack-protection/breached-password-detection

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.AttackProtection.BreachedPasswordDetection.GetAsync();
    }

}

package example

import (
    context "context"

    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
    }
    mgmt.AttackProtection.BreachedPasswordDetection.Get(
        context.TODO(),
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.attackProtection().breachedPasswordDetection().get();
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->attackProtection->breachedPasswordDetection->get();

from auth0.management import ManagementClient

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

client.attack_protection.breached_password_detection.get()

require "auth0"

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

client.attack_protection.breached_password_detection.get

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.attackProtection.breachedPasswordDetection.get();
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.attackProtection.breachedPasswordDetection.get();
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/attack-protection/breached-password-detection \
  --header 'Authorization: Bearer <token>'

200

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

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Response

200

application/json

Breached password detection settings successfully retrieved.

enabled · boolean · default: 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.

Available options: 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.

Available options: immediately, daily, weekly, monthly

method · enum<string> · default: standard

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

Available options: standard, enhanced

stage · object

Show child attributes