Auth0 · Schema

CreateGuardianEnrollmentTicketRequestContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
user_id	string	user_id for the enrollment ticket
email	string	alternate email to which the enrollment email will be sent. Optional - by default, the email will be sent to the user's default address
send_mail	boolean	Send an email to the user to start the enrollment
email_locale	string	Optional. Specify the locale of the enrollment email. Used with send_email.
factor	object
allow_multiple_enrollments	boolean	Optional. Allows a user who has previously enrolled in MFA to enroll with additional factors. Note: Parameter can only be used with Universal Login; it cannot be used with Classic Login or custom

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateGuardianEnrollmentTicketRequestContent",
  "title": "CreateGuardianEnrollmentTicketRequestContent",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "user_id"
  ],
  "properties": {
    "user_id": {
      "type": "string",
      "description": "user_id for the enrollment ticket",
      "format": "user-id"
    },
    "email": {
      "type": "string",
      "description": "alternate email to which the enrollment email will be sent. Optional - by default, the email will be sent to the user's default address",
      "format": "email"
    },
    "send_mail": {
      "type": "boolean",
      "description": "Send an email to the user to start the enrollment"
    },
    "email_locale": {
      "type": "string",
      "description": "Optional. Specify the locale of the enrollment email. Used with send_email."
    },
    "factor": {
      "$ref": "#/components/schemas/GuardianEnrollmentFactorEnum"
    },
    "allow_multiple_enrollments": {
      "type": "boolean",
      "description": "Optional. Allows a user who has previously enrolled in MFA to enroll with additional factors.<br />Note: Parameter can only be used with Universal Login; it cannot be used with Classic Login or custom MFA pages."
    }
  }
}