🟠PUT users

Updates the details of a user within the organisation.

Currently, this endpoint can only be used to update the details of users created with the POST users endpoint. Details for accounts created using other methods cannot be changed.

URL

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

Parameters

As this endpoint is a PUT and not a PATCH you will need to send the existing values for any parameters you do not want to change.

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
email*	string	The email of the user.
firstName*	string	The first name of the user.
lastName*	string	The last name of the user.
role*	string	The role of the user. (USER or ADMIN)
organisationIdentifier	string	The custom identifier for the user.

* required

Example

curl https://training.tapintosafety.com.au/api/v2/users \
    -X PUT                                              \
    -H "Authorization: Bearer $APIKey"                  \
    -H "Content-Type: application/json"                 \
    -d '{ "email": "[email protected]",            \
          "firstName": "Alice",                         \
          "lastName": "Smith",                          \
          "role": "USER",                               \
          "organisationIdentifier": "Employee#1282" }

Responses

204 - OK

No response body.

400 - Bad Request

Error Code: INVALID_MODEL

One or more parameters provided are invalid. See details for more information.

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: EMAIL_IN_USE

The email specified is already in use by another user.