Auth0 · Schema

UpdateBreachedPasswordDetectionSettingsRequestContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name Type Description
enabled boolean Whether or not breached password detection is active.
shields array Action to take when a breached password is detected during a login. Possible values: block, user_notification, admin_notification.
admin_notification_frequency array When "admin_notification" is enabled, determines how often email notifications are sent. Possible values: immediately, daily, weekly, monthly.
method object
stage object
View JSON Schema on GitHub

JSON Schema

auth0-updatebreachedpassworddetectionsettingsrequestcontent-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateBreachedPasswordDetectionSettingsRequestContent",
  "title": "UpdateBreachedPasswordDetectionSettingsRequestContent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Whether or not breached password detection is active.",
      "default": true
    },
    "shields": {
      "type": "array",
      "description": "Action to take when a breached password is detected during a login.\n      Possible values: <code>block</code>, <code>user_notification</code>, <code>admin_notification</code>.",
      "items": {
        "$ref": "#/components/schemas/BreachedPasswordDetectionShieldsEnum"
      }
    },
    "admin_notification_frequency": {
      "type": "array",
      "description": "When \"admin_notification\" is enabled, determines how often email notifications are sent.\n        Possible values: <code>immediately</code>, <code>daily</code>, <code>weekly</code>, <code>monthly</code>.",
      "items": {
        "$ref": "#/components/schemas/BreachedPasswordDetectionAdminNotificationFrequencyEnum"
      }
    },
    "method": {
      "$ref": "#/components/schemas/BreachedPasswordDetectionMethodEnum"
    },
    "stage": {
      "$ref": "#/components/schemas/BreachedPasswordDetectionStage"
    }
  }
}