Auth0 · Schema

VerifyEmailTicketRequestContent

AI AgentsAuthenticationAuthorizationFGAIdentity ManagementMCPOAuthOktaOpenID ConnectSAMLSecuritySCIM

Properties

Name	Type	Description
result_url	string	URL the user will be redirected to in the classic Universal Login experience once the ticket is used. Cannot be specified when using client_id or organization_id.
user_id	string	user_id of for whom the ticket should be created.
client_id	string	ID of the client (application). If provided for tenants using the New Universal Login experience, the email template and UI displays application details, and the user is prompted to redirect to the ap
organization_id	string	(Optional) Organization ID – the ID of the Organization. If provided, organization parameters will be made available to the email template and organization branding will be applied to the prompt. In a
ttl_sec	integer	Number of seconds for which the ticket is valid before expiration. If unspecified or set to 0, this value defaults to 432000 seconds (5 days).
includeEmailInRedirect	boolean	Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false).
identity	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/VerifyEmailTicketRequestContent",
  "title": "VerifyEmailTicketRequestContent",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "user_id"
  ],
  "properties": {
    "result_url": {
      "type": "string",
      "description": "URL the user will be redirected to in the classic Universal Login experience once the ticket is used. Cannot be specified when using client_id or organization_id.",
      "default": "http://myapp.com/callback",
      "format": "url"
    },
    "user_id": {
      "type": "string",
      "description": "user_id of for whom the ticket should be created.",
      "format": "user-id"
    },
    "client_id": {
      "type": "string",
      "description": "ID of the client (application). If provided for tenants using the New Universal Login experience, the email template and UI displays application details, and the user is prompted to redirect to the application's <a target='' href='https://auth0.com/docs/authenticate/login/auth0-universal-login/configure-default-login-routes#completing-the-password-reset-flow'>default login route</a> after the ticket is used. client_id is required to use the <a target='' href='https://auth0.com/docs/customize/actions/flows-and-triggers/post-change-password-flow'>Password Reset Post Challenge</a> trigger.",
      "default": "DaM8bokEXBWrTUFCiJjWn50jei6ardyX",
      "format": "client-id"
    },
    "organization_id": {
      "type": "string",
      "description": "(Optional) Organization ID \u2013 the ID of the Organization. If provided, organization parameters will be made available to the email template and organization branding will be applied to the prompt. In addition, the redirect link in the prompt will include organization_id and organization_name query string parameters.",
      "default": "org_2eondWoxcMIpaLQc",
      "format": "organization-id"
    },
    "ttl_sec": {
      "type": "integer",
      "description": "Number of seconds for which the ticket is valid before expiration. If unspecified or set to 0, this value defaults to 432000 seconds (5 days).",
      "minimum": 0
    },
    "includeEmailInRedirect": {
      "type": "boolean",
      "description": "Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false)."
    },
    "identity": {
      "$ref": "#/components/schemas/Identity"
    }
  }
}