Sign in
Users

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}

Path parameters

idstring required

Unique identifier for the user.

Request body

firstNamestring nullable

First name of the user.

lastNamestring nullable

Last name of the user.

emailstring email nullable

Email address of the user.

companystring nullable

Company of the user.

organizationIdstring nullable

Unique identifier for the organization.

resellerIdstring nullable

Unique identifier for the reseller.

allowCustomerPortalAccessboolean nullable

Allow customer portal access.

tagsstring[] nullable

List of tags.

rolestring nullable

Role of the user.

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
namestring required
firstNamestring required
lastNamestring required
emailstring required
rolestring required
twoFactorEnabledboolean required
googleSsoEnabledboolean required
lastLoginAtstring date-time nullable
twoFactorRequiredFromstring date-time nullable
companystring nullable
allowCustomerPortalAccessboolean required
rolesstring[] required
lastSeenAtstring date-time nullable
organizationIdstring nullable
resellerIdstring nullable
tagsstring[] required

Changes

Changed in 1 of the 2 revisions of this API.6

  • 66dcb62931806See the full diff
    • ○

      added the new optional request property customAttributes

      new-optional-request-property

    • ○

      added the optional property twoFactorRequiredFrom to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property customAttributes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property organization/customAttributes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property organization/reseller/customAttributes to the response with the 200 status

      response-required-property-added

    • ○

      added the required property reseller/customAttributes to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog