Skip to main content
Browse Documentation
HTTP - Management

Patch update a user

Created by c.neale, last updated 19 Jan 2021

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

NameParameter typeTypeFormatDescriptionExampleRequired
UserIdentifierpathstringuser identifierFor 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 userbodyobjectpartial userA partial view of the user resourcetrue
Content Typeheaderstringhttp headerA Content-Type http header with value 'application/merge-patch+json; charset=utf-8'Content-Type: application/merge-patch+json; charset=utf-8true

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.

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.

 

Responses

HTTP status codeReasonModel
200SuccessUser
401UnauthorizedError
403ForbiddenError
404User not foundError
500Internal server errorError