Auth0 · Schema

SetUserAuthenticationMethods

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
type	object
preferred_authentication_method	object
name	string	AA human-readable label to identify the authentication method.
phone_number	string	Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice.
email	string	Applies to email authentication methods only. The email address used to send verification messages.
totp_secret	string	Applies to totp authentication methods only. The base32 encoded secret for TOTP generation.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SetUserAuthenticationMethods",
  "title": "SetUserAuthenticationMethods",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "$ref": "#/components/schemas/AuthenticationTypeEnum"
    },
    "preferred_authentication_method": {
      "$ref": "#/components/schemas/PreferredAuthenticationMethodEnum"
    },
    "name": {
      "type": "string",
      "description": "AA human-readable label to identify the authentication method.",
      "minLength": 1,
      "maxLength": 20
    },
    "phone_number": {
      "type": "string",
      "description": "Applies to phone authentication methods only. The destination phone number used to send verification codes via text and voice.",
      "minLength": 2,
      "maxLength": 30
    },
    "email": {
      "type": "string",
      "description": "Applies to email authentication methods only. The email address used to send verification messages.",
      "minLength": 1
    },
    "totp_secret": {
      "type": "string",
      "description": "Applies to totp authentication methods only. The base32 encoded secret for TOTP generation.",
      "minLength": 1
    }
  }
}