Patch update a user
For efficiency and convenience a partial user resource can be sent to the user resource collection in a PATCH request in order to update a sub-set of properties on the user.
PATCH/api/security/users/{userIdentifier}
Parameters
| Name | Parameter type | Type | Format | Description | Example | Required |
|---|---|---|---|---|---|---|
| UserIdentifier | path | string | user identifier | For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id. | "82f73a9b-2a13-4d63-bcc1-e8ee5047b01c" or "t.durden" or "t.durden@fightclub.com" | true |
| Partial user | body | object | partial user | A partial view of the user resource | true | |
| Content Type | header | string | http header | A Content-Type http header with value 'application/merge-patch+json; charset=utf-8' | Content-Type: application/merge-patch+json; charset=utf-8 | true |
Example
Update just the user's name and some of the custom properties. Custom properties that already exist will be updated, those that don't will be created.
PATCH: /api/security/users/4b262379-5bbe-421e-a429-f6e2ab5a849b
Content-Type: application/merge-patch+json; charset=utf-8
{
"id": "e09e77b9-9dd9-4d46-b7dd-deb9702a5835",
"username": "s.yearsley",
"custom": {
"department": "finance"
}
}Remarks
All properties of the user resource object are optional apart from the id.
Any value provided for expiry must be a future date. To clear an expiry date set the expiry property to null.
As shown in the example, a special header value of 'application/merge-patch+json; charset=utf-8' is required for the Content-Type http header.
Permissions
Members of System Administrators are permitted to patch any user.
Authenticated standard user accounts are permitted to patch their own user.