Update User

put

https://{hostname}/api/access/v2/users/{userId}

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

Path Params

userId

uuid

required

The unique identifier of the user.

Body Params

firstName

string

required

length between 0 and 100

The first name of the user.

lastName

string

required

length between 0 and 100

The last name of the user.

internal

boolean

Defaults to false

The indicator of whether the user is an internal user.

expirationDateTime

date-time

User expiration date in the system

externalId

string

length between 0 and 128

The external identifier for the user.

accessLevels

array of objects

length ≥ 1

accessLevels

organizationId

uuid

required

The unique identifier of the organization.

roleIds

array of uuids

length ≥ 1

The list of role identifiers to be associated with the organization.

roleIds

defaultOrganization

boolean

Defaults to false

The indicator of whether the provided organization will be treated as the default organization.

Responses

200

User updated successfully

400

Invalid request data

401

Unauthorized - Invalid or missing authentication

403

Forbidden - Insufficient permissions

500

Internal Server Error

Language

Credentials

OAuth2

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

429Too Many Requests. For more information, see API Rate Limits.