Patch update a user
Log in to add to favouritesPATCH/api/security/users/{userIdentifier}
Parameters
| Name | Parameter type | Type | Format | Description |
|---|---|---|---|---|
| UserIdentifier(required) | path | string | user identifier | For convenience, User resources can be referenced by using one of several identifiers - username, email address or Id. |
| Partial user(required) | body | object | partial user | A partial view of the user resource |
| Content Type(required) | header | string | http header | A Content-Type http header with value 'application/merge-patch+json; charset=utf-8' |
Responses
Examples
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.