Package com.auth0.json.mgmt.tickets
Class EmailVerificationTicket
java.lang.Object
com.auth0.json.mgmt.tickets.EmailVerificationTicket
Class that represents an Auth0 Email Verification Ticket object. Related to the
TicketsEntity
entity.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGetter for the ticket url.void
setClientId(String clientId)
Sets the ID of the client.void
setIdentity(EmailVerificationIdentity identity)
Sets the identity.void
setIncludeEmailInRedirect(Boolean includeEmailInRedirect)
Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false).void
setOrganizationId(String organizationId)
Sets the ID of the Organization.void
setResultUrl(String resultUrl)
Setter for the url the user will be redirected to after using the ticket.void
setTTLSeconds(Integer seconds)
The ticket's lifetime in seconds starting from the moment of creation.void
Setter for the id of the user this ticket is meant to.
-
Constructor Details
-
EmailVerificationTicket
-
-
Method Details
-
setUserId
Setter for the id of the user this ticket is meant to.- Parameters:
userId
- the user id to set.
-
setResultUrl
Setter for the url the user will be redirected to after using the ticket.- Parameters:
resultUrl
- the result url.
-
setTTLSeconds
The ticket's lifetime in seconds starting from the moment of creation. After expiration the ticket can not be used to verify the users's email. If not specified or if you send 0 the Auth0 default lifetime will be applied.- Parameters:
seconds
- the lifetime in seconds to set.
-
setIncludeEmailInRedirect
Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false).- Parameters:
includeEmailInRedirect
- whether to include the email address as part of the returnUrl in the reset email.
-
setClientId
Sets the ID of the client. If provided for tenants using New Universal Login experience, the user will be prompted to redirect to the default login route of the corresponding application once the ticket is used.- Parameters:
clientId
- the ID of the client- See Also:
- Configuring Default Login Routes
-
setOrganizationId
Sets 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 includeorganization_id
andorganization_name
query string parameters.- Parameters:
organizationId
- the ID of the organization
-
setIdentity
Sets the identity. Needed to verify primary identities when using social, enterprise, or passwordless connections. It is also required to verify secondary identities.- Parameters:
identity
- the identity.
-
getTicket
Getter for the ticket url.- Returns:
- the ticket url.
-