Initiate password reset
Generates a secure, time-bound password reset link for the specified user. The link may be delivered directly to the user or returned for custom distribution.
API-KeyX-API-KEY<token>MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>
The unique identifier of the user.
Request Body
application/json
The request payload used to generate a password reset link.
TypeScript Definitions
Use the request body type in TypeScript.
Reset Password Request: Defines the options used to initiate a password reset flow for a user.
Response Body
application/json
The password reset link was generated successfully
TypeScript Definitions
Use the response body type in TypeScript.
Reset Password Response: Returns the delivery status of the password reset email.
Errors
curl -X POST "https://your-domain.us.monocloud.com/api/users/WUgDGqaqzqkRmsgd3PFAT/password/reset" \ -H "X-API-KEY: <token>" \ -H "Content-Type: application/json" \ -d '{}'{ "link": "string", "expires_at": 0, "email_sent": true}Clear a password reset requirement DELETE
Clears the enforced password reset requirement for the user's next password-based authentication attempt.
Change password PUT
Replaces the user's existing password after validating the current password. Accepts either plaintext input or a pre-computed hash generated with a supported algorithm for the new password.