Update a user

Updates the specified user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/users/{id}
JWTuser:write

Path parameters

idstringrequired

Unique identifier for the user.

Request body

firstNamestring

First name of the user.

Length: [1,256]

lastNamestring

Last name of the user.

Length: [0,256]

emailstring

Email address of the user.

Length: [1,256]Format: email

companystring

Company of the user.

Length: [0,256]

organizationIdstring

Unique identifier for the organization.

Length: [0,256]

resellerIdstring

Unique identifier for the reseller.

Length: [0,256]

allowCustomerPortalAccessboolean

Allow customer portal access.

metadataarray of object

List of metdata key/value pairs.

customAttributesarray of object

List of custom attribute name/value pairs.

tagsarray of string

List of tags.

rolestring

Role of the user.

Length: [1,256]

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
firstNamestringrequired
lastNamestringrequired
emailstringrequired
rolestringrequired
twoFactorEnabledbooleanrequired
googleSsoEnabledbooleanrequired
allowCustomerPortalAccessbooleanrequired
metadataarray of objectrequired
customAttributesarray of objectrequired
tagsarray of stringrequired
lastLoginAtstring

Format: date-time

twoFactorRequiredFromstring

Format: date-time

companystring
lastSeenAtstring

Format: date-time

organizationIdstring
organizationobject
resellerIdstring
resellerobject