OrganizationUsers

Update an organization user

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

patch/v3/organizations/{organizationId}/users/{id}

Path parameters

organizationIdstring required
idstring required

Unique identifier for the organization 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.

rolestring nullable

Role of the user.

userGroupIdsstring[] nullable

List of unique identifiers for the user groups.

allowCustomerPortalAccessboolean nullable

Allow customer portal access.

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

Changes

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

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

      response-optional-property-added

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