v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

userManagement

Update a user.

Update an existing user in the organization.

put/v1/users/{id}

Path parameters

idstring required

Identifier of the user to update.

Request body

firstNamestring required

First name of the user. If the caller has manageUsersAndRoles capability, this field can be updated for any user. If the caller does NOT have manageUsersAndRoles capability, then only the calling user's firstName can be updated.

lastNamestring required

Last name of the user. If the caller has manageUsersAndRoles capability, this field can be updated for any user. If the caller does NOT have manageUsersAndRoles capability, then only the calling user's lastName can be updated.

isActiveboolean

This has the value true if the user is active and false if they have been deactivated. To modify this field you must have the manageUserAndRoles capability.

roleIdsstring[]

List of role identifiers associated with the user. To modify this field you must have the manageUserAndRoles capability.

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "isActive": true,
  "roleIds": [
    "00000000000001DF",
    "00000000000002D2"
  ]
}

Response

The user was successfully modified.

firstNamestring required

First name of the user.

lastNamestring required

Last name of the user.

emailstring email required

Email address of the user.

roleIdsstring[] required

List of roleIds associated with the user.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

idstring required

Unique identifier for the user.

isActiveboolean

True if the user is active.

isLockedboolean

This has the value true if the user's account has been locked. If a user tries to log into their account several times and fails, his or her account will be locked for security reasons.

isMfaEnabledboolean

True if multi factor authentication is enabled for the user.

lastLoginTimestampstring date-time

Timestamp of the last login for the user in UTC. Will be null if the user has never logged in.

Example response

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@acme.com",
  "roleIds": [
    "00000000000001DF",
    "00000000000002D2"
  ],
  "createdAt": "2018-10-16T09:10:00Z",
  "createdBy": "0000000006743FDD",
  "modifiedAt": "2018-10-16T09:10:00Z",
  "modifiedBy": "0000000006743FE8",
  "id": "000000000FE20FE2",
  "isActive": true
}