Skip to main content
Browse Documentation
HTTP - Management

Update a user

Created by s.yearsley, last modified by m.summerfield on 16 Jan 2023

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

JSON
PUT: /api/security/users/4b262379-5bbe-421e-a429-f6e2ab5a849b { "username": "t.durden", "email": "t.durden@fightclub.com", "firstName": "Tyler", "lastName": "Durden", "timezone": "America/New_York", "expiry": "2050-12-31T23:59:59.999Z", "language": "en-US", "credentials":{ "passwordChangeFrequency": 365 }, "custom": { "department": "Soap sales" } }

Remarks

Any value provided for expiry must be a future date.  To clear an expiry date set the expiry property to null.

 

Permissions

Members of System Administrators are permitted to update any user.

Authenticated standard user accounts are permitted to update their own user.

Responses

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