Update on PUT user API call
This commit is contained in:
@@ -7,20 +7,21 @@ This PUT request updates a user.
|
||||
```
|
||||
|
||||
#### Permissions required
|
||||
`admin-access-admins` RW.
|
||||
`admin-access-admins` RW. If you are changing your own user you don't need any permissions.
|
||||
|
||||
#### Body parameters
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------ | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||
| user_uuid | uuid | yes | The users unique id. |
|
||||
| user_group_uuid | uuid | yes | The user-group unique id for the user. |
|
||||
| user_email | email | yes | The email address of the user. |
|
||||
| user_first_name | string | yes | The first name of the user. |
|
||||
| user_last_name | string | yes | The last name of the user. |
|
||||
| user_phone_number | string | yes | The phone number of the user. |
|
||||
| user_status | enum | yes | The user status of the user. Either `inactive`, `banned` or `pending` |
|
||||
| user_pref_language | enum | yes | Either `en` or `nl` |
|
||||
| user_stompable | boolean | yes | Makes the user stompable, related to the [stompjes](API/v1/office/stompjes/POST%20Stomp%20user.md) in the office module. |
|
||||
| Parameter | Type | Required | Description |
|
||||
| ------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| user_uuid | uuid | yes | The users unique id. |
|
||||
| user_group_uuid | uuid | yes | The user-group unique id for the user. <br>*Not allowed when changing own user.* |
|
||||
| user_email | email | yes | The email address of the user. |
|
||||
| user_first_name | string | yes | The first name of the user. |
|
||||
| user_last_name | string | yes | The last name of the user. |
|
||||
| user_phone_number | string | no | The phone number of the user. |
|
||||
| user_status | enum | yes | The user status of the user. Either `inactive`, `banned` or `pending`.<br>*Not allowed when changing own user.* |
|
||||
| user_pref_language | enum | yes | Either `en` or `nl` |
|
||||
| user_stompable | boolean | no | Makes the user stompable, related to the [stompjes](API/v1/office/stompjes/POST%20Stomp%20user.md) in the office module.<br>*Not allowed when changing own user.* |
|
||||
| user_profile_change | boolean | no | Add this value to change your own profile. |
|
||||
|
||||
### Example Body (json)
|
||||
```json
|
||||
|
||||
Reference in New Issue
Block a user