Sign in

v2

OpenAPI 3.0.02026-08-051996591.2 MB
Users

Reset a user password

Resets the password for a user.

post/v2/users/{username}/reset_password

Path parameters

usernamestring required

The username of the user whose password to reset. The username must be percent encoded and URI safe.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Response

A password reset email was sent to the user.

one_time_codestring

A one-time code to reset the password. This is optional, and is only populated for some platform deployments.

one_time_code_linkstring

The link where the user enters the one_time_code. This is optional, and is only populated for some platform deployments.