Auth0 Node.js SDK - v5.0.0
    Preparing search index...

    Interface ChangePasswordTicketRequestContent

    {}
    interface ChangePasswordTicketRequestContent {
        result_url?: string;
        user_id?: string;
        client_id?: string;
        organization_id?: string;
        connection_id?: string;
        email?: string;
        ttl_sec?: number;
        mark_email_as_verified?: boolean;
        includeEmailInRedirect?: boolean;
    }
    Index

    Properties

    result_url? user_id? client_id? organization_id? connection_id? email? ttl_sec? mark_email_as_verified? includeEmailInRedirect?

    Properties

    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?: string

    user_id of for whom the ticket should be created.

    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.

    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.

    connection_id?: string

    ID of the connection. If provided, allows the user to be specified using email instead of user_id. If you set this value, you must also send the email parameter. You cannot send user_id when specifying a connection_id.

    email?: string

    Email address of the user for whom the tickets should be created. Requires the connection_id parameter. Cannot be specified when using user_id.

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

    mark_email_as_verified?: boolean

    Whether to set the email_verified attribute to true (true) or whether it should not be updated (false).

    includeEmailInRedirect?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties