• management
• Management
• VerifyEmailTicketRequestContent

Interface VerifyEmailTicketRequestContent

Example

{ * user_id: "user_id" * }Copy

interface VerifyEmailTicketRequestContent {
result_url?: string;
user_id: string;
client_id?: string;
organization_id?: string;
ttl_sec?: number;
includeEmailInRedirect?: boolean;
identity?: Identity;
}

Index

Properties

result_url?user_idclient_id?organization_id?ttl_sec?includeEmailInRedirect?identity?

Properties

Optionalresult_url

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

user_id: string

user_id of for whom the ticket should be created.

Optionalclient_id

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 application's default login route after the ticket is used. client_id is required to use the Password Reset Post Challenge trigger.

Optionalorganization_id

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 addition, the redirect link in the prompt will include organization_id and organization_name query string parameters.

Optionalttl_sec

ttl_sec?: number

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).

OptionalincludeEmailInRedirect

includeEmailInRedirect?: boolean

Whether to include the email address as part of the returnUrl in the reset_email (true), or not (false).

Optionalidentity

identity?: Identity

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties result_urluser_idclient_idorganization_idttl_secincludeEmailInRedirectidentity