Web Service Method: Update a User
Web Service Method: Update a User
Description |
|---|
Updates details of a user on a PoolParty server. |
Note
Only works when the server is using https.
URL: /PoolParty/api/user/updateUser
Request
Supported Methods |
|---|
POST |
application/x-www-form-urlencoded
Variable | Comment |
|---|---|
| The UUID or the URI supplement (textual identifier) of the project to be used. |
Parameter | Comment | Type | Required |
|---|---|---|---|
name | User name of the user for whom the details should be updated. | String | true |
newName | Changes the existing user name. | String | false |
fullname | Override existing new full name. Usually, this field consists of first and last name. | String | false |
password | Override existing password. | String | false |
groups | Override existing set of groups the user has access to. NoteFind details about the syntax to send multiple groups in one request here:Using a List of Request Parameters | String | false |
roles | Override existing roles of the user. NoteFind details about the syntax to send multiple roles in one request here:Using a List of Request Parameters | String | false |
Response
http status code 200if OK.
Example
Basic Pattern
https://<server-url>/PoolParty/api/user/updateUser?name=<user-name>&roles=<list_of_roles>
The following screenshot shows the override of the full name and groups of an existing user with username 'testuser' using Postman:
 |