🟢POST users/password

Updates the password of a user within the organisation.

Currently, this endpoint can only be used to change the password of users created with the POST users endpoint. Passwords for accounts created using other methods cannot be changed.

URL

POST https://training.tapintosafety.com.au/api/v2/users/password

Parameters

Schema

Query Parameters

Name	Type	Description
userIdentifier*	string	The identifier of the user to update. Can be the users email or Id.

* required

Body Parameters

Name	Type	Description
password	string	The new password for the user. Set to null to remove the password.

Example

curl "https://training.tapintosafety.com.au/api/v2/users/password?userIdentifier=[e-mail]" \
    -d '{"password":"ExamplePassword1"}' \
    -H "Authorization: Bearer $APIKey"   \
    -H "Content-Type: application/json"  

Responses

204 - OK

No response body.

400 - Bad Request

Error Code: INVALID_MODEL

userIdentifier has not been specified.

400 - Bad Request

Error Code: USER_NOT_FOUND

A user could not be found with the specified userIdentifier

400 - Bad Request

Error Code: INVALID_USER_TYPE

The user specified was not created with the POST users endpoint and cannot be updated here.

400 - Bad Request

Error Code: INVALID_PASSWORD

The password specified does not meet the security requirements. See details for more information.