Password Reset

POST
/api/users/[user_id]/password/reset
Generates a link and send out an email which can be used to reset the user password.

Path Parameters

user_id
string
Required

The ID of the user whose password reset link is requested.

Body Parameters

send_email
boolean

Specifies whether to send the password reset email to the user.

Default:
false
expiry
number
Nullable

Specifies the expiry time for the password reset link (in seconds).

Authentication

API-Key
header
Required

The API key is essential for accessing MonoCloud's APIs. You can find it in the Tenant Settings section of your MonoCloud dashboard. To authenticate your requests, include this key in the request header using the following format: X-API-Key: <Your_API_Key>.

Headers

content-type
string
  • application/json
accept
string
  • application/json
  • application/problem+json

Responses

200
Successfully generated password reset link for the user.
404
Not Found
422
Client Error
401
Unauthorized
403
Forbidden

Request Example

Request
curl -X POST "https://<your-domain>/api/users/{user_id}/password/reset" \
 -H "X-API-KEY: <your-api-key>" \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 --data-raw '{
  "send_email" : false,
  "expiry" : 600
}'

Response Example

Response
200 OK
{
  "email_sent": false,
  "expires_at": 1640975400,
  "link": "https://domain.us.monocloud.com/ui/passwordReset/verify?state=xaAUMGOyIOKIK4SGYGUuqsSGPmclTGG3"
}