v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB

Users

Replace the password of a user

🔑

Required OAuth scope: users:write.

Replaces the password of a user with the provided data. If 'passwordMustBeChanged' is set to true, the user will be forced to change their password on the next login.

put/api/v2/users/{userId}/password

Path parameters

userIdstring ObjectId required

Example:507f1f77bcf86cd799439011

The unique ID of the user.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

passwordstring required

The new password of the given user. The new password must be at least 8 characters long and it might be subject to company based rules. Example: 'password' : 'my_s3cret.PAssw0rd'.

passwordMustBeChangedboolean required

True if the user must change their password when first logging into the platform; false otherwise.

Response

Replaces the password of a user with the provided data.