Password Change Ticket

Report issue
Create a password change ticket for a user. Important Notes: - The `client_id` parameter is required and must be the client ID of the application that will be used to log in after the password change. - If `email` is provided, `user_id` is not required. At the same time, if `email` is provided, `connection_id` is required. - The `headers` must include the `auth0-custom-domain` header with the value of the custom domain for the environment being used. For example, `https://clasp.dev.jewelersmutual.com` for development. Connection IDs - Development: `con_meNq3yVUsR5kRPvG` - Test: `con_K86wfZeUvywiYgRR` - Stage: `con_mC0z1hHAoq3JAzYw` - Production: `con_F4H2mnA2OYBiLNDP`

Authentication

AuthorizationBearer

Auth0-issued access token for the Auth0 Management API audience.

Request

This endpoint expects an object.
client_idstringRequired
The client ID of the application that will be used to log in after the password change.
mark_email_as_verifiedbooleanRequired
Whether to mark the user's email as verified after they change their password.
user_idstringOptional

The ID of the user for whom to create the password change ticket. If email is provided, this parameter is not required.

emailstringOptional

The email of the user for whom to create the password change ticket. If user_id is provided, this parameter is not required. If email is provided, connection_id is required.

connection_idstringOptional

The ID of the connection to which the user belongs. Required if email is provided.

ttl_secintegerOptional

The time-to-live (TTL) of the ticket in seconds. Defaults to 432000 seconds (5 days). Maximum value is 432000 seconds (5 days).

Response

Password change ticket successfully created.
ticketstringOptionalDefaults to https://clasp.dev.jewelersmutual.com/lo/reset?ticket=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2NsYXNwLmRldi5qZXdlbGVyc211dHVhbC5jb20iLCJzdWIiOiJhdXRoMHw1MDdmMWY3N2JjZjg2Y2Q3OTk0MzkwMjAiLCJhdWQiOiJodHRwczovL2NsYXNwLmRldi5qZXdlbGVyc211dHVhbC5jb20vYXBpL3YyLyIsImlhdCI6MTY4NjE4NzQxMywiZXhwIjoxNjg2Mjc3ODEzfQ.7n8r6zZf8
The URL of the password change ticket.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error