Package com.auth0.json.mgmt.tickets

Class EmailVerificationTicket

java.lang.Object

com.auth0.json.mgmt.tickets.EmailVerificationTicket

public class EmailVerificationTicket
extends Object

Class that represents an Auth0 Email Verification Ticket object. Related to the TicketsEntity entity.

Constructor Summary

Constructors

Constructor	Description
EmailVerificationTicket(String userId)

Method Summary

Modifier and Type	Method	Description
String	getTicket()	Getter 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	setUserId(String userId)	Setter for the id of the user this ticket is meant to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EmailVerificationTicket

public EmailVerificationTicket(String userId)

Method Details

setUserId

public void setUserId(String userId)

Setter for the id of the user this ticket is meant to.

Parameters:

userId - the user id to set.

setResultUrl

public void setResultUrl(String resultUrl)

Setter for the url the user will be redirected to after using the ticket.

Parameters:

resultUrl - the result url.

setTTLSeconds

public void setTTLSeconds(Integer seconds)

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

public void setIncludeEmailInRedirect(Boolean includeEmailInRedirect)

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

public void setClientId(String clientId)

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

public void setOrganizationId(String organizationId)

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 include organization_id and organization_name query string parameters.

Parameters:

organizationId - the ID of the organization

setIdentity

public void setIdentity(EmailVerificationIdentity identity)

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

public String getTicket()

Getter for the ticket url.

Returns:

the ticket url.