Update User

Use this endpoint to update a users profile information, role, or group assignments. If any data is not changing, please omit it from your request as only the data that is changing is needed.

SecurityOAuth2
Request
path Parameters
userId
required
string <uuid> = 36 characters

The User Identifier to User Profile data for.

Example: 4e428628-2537-40b5-91a4-5393cbf167df
header Parameters
content-type
string
Example: application/json
Authorization
string
Example: Bearer <token>
Request Body schema: application/json
firstName
string or null
lastName
string or null
friendlyName
string
email
string or null <email>
country
string or null
company
string or null
phone
string or null
contact
string or null

Provide a name for the Point of Contact associated to this user.

roleId
string or null

The ID of the Role that will be assigned to this user

groups
Array of strings or null (user-groups)

List of user group IDs to assign when creating users or that the user belongs to.

Responses
200

Successful Request. User Updated Successfully.

400

One or more required parameters are missing or invalid.

401

Authentication failed (unauthorized).

403

Forbidden. You do not have permissions to perform this action, or your connection information is not correct.

503

The server is too busy to handle the request.

patch/users/{userId}
Request samples
application/json
{
  • "firstName": "John",
  • "lastName": "Wick",
  • "friendlyName": "John Wick",
  • "email": "john.wick@tenovos.com",
  • "country": "USA",
  • "company": "Tenovos",
  • "phone": "15402166600",
  • "contact": "Winston at the Continental",
  • "roleId": "7d5620e0-f423-11e9-8071-89c0c4052141",
  • "groups": [
    ]
}
Response samples
application/json
{
  • "users": [
    ]
}