Site Home
API Reference
LoginTry for Free

Request Password Reset

post
https://{application_vanity_domain}/api/v1/password-reset/request-password-reset
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Sends a password reset email to the user with the specified email address.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.

PermissionBoundaryDescription
password-reset-workflow:executeApplicationThe subject can perform this operation for requests associated with the application to which the subject belongs.
Body Params

Request Password Reset Request JSON object

Object representing a request to generate a password reset request.

string
required
length between 1 and 26

The ID of the tenant associated to the request.

string
required
length between 1 and 200

The email address to send the reset email to.

string
length between 1 and 26

ID of the client making the password reset request. If provided, it will be used to resolve the client login URL when immediate login is enabled for the password reset flow.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?