v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

Users V2

Update User

Use this API to update the details for a single user in your account.

put/api/access/v2/users/{userId}

Path parameters

userIdstring uuid required

The unique identifier of the user.

Request body

firstNamestring required

The first name of the user.

lastNamestring required

The last name of the user.

internalboolean

The indicator of whether the user is an internal user.

expirationDateTimestring date-time

User expiration date in the system

externalIdstring

The external identifier for the user.

Example request

{
  "firstName": "Michael",
  "lastName": "Douglas",
  "internal": true,
  "expirationDateTime": "2029-05-01T12:34:56Z",
  "externalId": "1A2234-abc",
  "accessLevels": [
    {
      "organizationId": "323e4567-e89b-12d3-a456-426614174000",
      "roleIds": [
        "550e8400-e29b-41d4-a716-446655440000"
      ],
      "defaultOrganization": true
    }
  ]
}

Response

User updated successfully