Package com.auth0.json.mgmt.tickets
Class PasswordChangeTicket
java.lang.Object
com.auth0.json.mgmt.tickets.PasswordChangeTicket
Class that represents an Auth0 Password Change Ticket object. Related to the
TicketsEntity
entity.-
Constructor Summary
ConstructorDescriptionPasswordChangeTicket(String userId)
PasswordChangeTicket(String email, String connectionId)
-
Method Summary
Modifier and TypeMethodDescriptionGets the organization IDGetter for the ticket url.void
setClientId(String clientId)
Setter for the client_idvoid
setConnectionId(String connectionId)
Setter for the id of the connection the user's email should be search in.void
Setter for the user's email.void
setIncludeEmailInRedirect(Boolean includeEmailInRedirect)
void
setMarkEmailAsVerified(Boolean markEmailAsVerified)
Setter for the mark_email_as_verified to define if user.email_verified should be set to true after ticket is consumed.void
setNewPassword(char[] newPassword)
void
setNewPassword(String newPassword)
Deprecated.Use setNewPassword(char[]) instead.void
setOrganizationId(String orgId)
Sets the organization ID.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 for whom the ticket should be created.
-
Constructor Details
-
PasswordChangeTicket
-
PasswordChangeTicket
-
-
Method Details
-
setUserId
Setter for the id of the user for whom the ticket should be created.- Parameters:
userId
- the user id to set.
-
setClientId
Setter for the client_id- Parameters:
clientId
- the ID of the client to set
-
setIncludeEmailInRedirect
-
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.
-
setNewPassword
Deprecated.Use setNewPassword(char[]) instead.Setter for the new password to set after the ticket is used.- Parameters:
newPassword
- the new password to set.
-
setNewPassword
public void setNewPassword(char[] newPassword) -
setConnectionId
Setter for the id of the connection the user's email should be search in.- Parameters:
connectionId
- the connection id
-
setEmail
Setter for the user's email.- Parameters:
email
- the user email to set.
-
setMarkEmailAsVerified
Setter for the mark_email_as_verified to define if user.email_verified should be set to true after ticket is consumed.- Parameters:
markEmailAsVerified
- true if email_verified attribute must be set to true once password is changed, false if email_verified attribute should not be updated.
-
setOrganizationId
Sets the organization ID. This allows the organization_id and organization_name to be included in the redirect URL query.- Parameters:
orgId
- the ID of the organization
-
getOrganizationId
Gets the organization ID- Returns:
- the organization ID
-
getTicket
Getter for the ticket url.- Returns:
- the ticket url.
-