Set a password
Sets or replaces the user's password. Accepts either plaintext input or a pre-computed hash generated with a supported algorithm.
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 set the user's password.
TypeScript Definitions
Use the request body type in TypeScript.
Set Password Request: Used to set or update a user's password, with support for plaintext or pre-hashed values.
Response Body
application/json
The password was set successfully
TypeScript Definitions
Use the response body type in TypeScript.
User: Represents a user account returned by the operation.
Errors
curl -X PUT "https://your-domain.us.monocloud.com/api/users/WUgDGqaqzqkRmsgd3PFAT/password" \ -H "X-API-KEY: <token>" \ -H "Content-Type: application/json" \ -d '{}'{ "user_id": "string", "disabled": true, "claims": { "property1": null, "property2": null }, "public_data": { "property1": null, "property2": null }, "private_data": { "property1": null, "property2": null }, "emails": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "primary": true, "verified": true, "source": null, "verification_source": null, "email": "string" } ], "phone_numbers": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "primary": true, "verified": true, "source": null, "verification_source": null, "phone": "string" } ], "passkeys": [ { "name": null, "passkey_id": "string", "public_key": "string", "aa_guid": "8a066881-0124-4a97-b518-fe03ecf6e108", "backup_state": true, "backup_eligibility": true, "user_present": true, "user_verified": true, "user_agent": "string" } ], "force_password_reset": true, "external_providers": [ { "provider": "string", "authenticator": "google", "provider_user_id": "string", "claims": { "property1": null, "property2": null } } ], "creation_time": 0, "last_updated": 0, "username": null, "has_password": true, "password_updated_at": null, "block_until": null, "failure_count": 0, "sign_in_attempts_count": 0, "last_sign_in_attempt": null, "last_sign_in_attempt_ip": null, "sign_in_success_count": 0, "last_sign_in_success": null, "last_sign_in_success_ip": null, "last_activity": null, "last_known_city": null, "last_known_country": null, "last_known_region": null}Remove the user's password DELETE
Removes the password from the specified user’s account. Once removed, the user will no longer be able to authenticate using a password until a new one is set.
Require password reset POST
Enforces a requirement for the user to reset their password at their next password-based sign-in.