Class PasswordChangeTicketRequest

Namespace

Auth0.ManagementApi.Models

Assembly

Auth0.ManagementApi.dll

public class PasswordChangeTicketRequest

Inheritance

object

PasswordChangeTicketRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ClientId

ID of the client. If provided for tenants using the 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. See Configuring Default Login Routes for more details.

[JsonProperty("client_id")]
public string ClientId { get; set; }

Property Value

string

ConnectionId

The connection that provides the identity for which the password is to be changed. If sending this parameter, the Email is also required and the UserId is invalid.

[JsonProperty("connection_id")]
public string ConnectionId { get; set; }

Property Value

string

Email

The user's email.

[JsonProperty("email")]
public string Email { get; set; }

Property Value

string

IncludeEmailInRedirect

Whether the reset_email will include the email as part of the returnUrl.

[JsonProperty("includeEmailInRedirect")]
public bool? IncludeEmailInRedirect { get; set; }

Property Value

bool?

MarkEmailAsVerified

Whether the email_verified attribute will be set once the password is changed.

[JsonProperty("mark_email_as_verified")]
public bool? MarkEmailAsVerified { get; set; }

Property Value

bool?

OrganizationId

The organization ID.

[JsonProperty("organization_id")]
public string OrganizationId { get; set; }

Property Value

string

ResultUrl

The user will be redirected to this endpoint once the ticket is used.

[JsonProperty("result_url")]
public string ResultUrl { get; set; }

Property Value

string

Ttl

The ticket's lifetime in seconds starting from the moment of creation. After expiration the ticket can not be used to change the users's password. If not specified or if you send 0 the Auth0 default lifetime will be applied

[JsonProperty("ttl_sec")]
public int? Ttl { get; set; }

Property Value

int?

UserId

The user ID for which the ticket is to be created.

[JsonProperty("user_id")]
public string UserId { get; set; }

Property Value

string