Skip to main content
Browse Documentation
HTTP - Management

Update a user

Created by s.yearsley, last updated 24 Sep 2020

Updating a user can be done by PUT'ing an updated version of the user profile resource.

PUT/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
userbodyobjectuserThe user to createtrue

Example

PUT: /api/security/users/4b262379-5bbe-421e-a429-f6e2ab5a849b
{
    "username": "tdurden",
    "email": "t.turden@fightclub.com",
    "firstname": "Tyler",
    "lastname": "Durden",
    "timezone": "America/New_York",
    "language": "en-US",
    "custom": {
        "department": "Soap sales"
    }
}

Remarks

Only the current user and a member of the System Administrators group can update a user resource.

Responses

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