PUT /v1/users/{id}

Update an existing user in the organization.

Servers

Path parameters

Name Type Required Description
id String Yes

Identifier of the user to update.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
lastName String Yes

Last name of the user. If the caller has manageUsersAndRoles capability, this field can be updated for any user. If the caller does NOT have manageUsersAndRoles capability, then only the calling user's lastName can be updated.

roleIds[] Array No

List of role identifiers associated with the user. To modify this field you must have the manageUserAndRoles capability.

isActive Boolean No

This has the value true if the user is active and false if they have been deactivated. To modify this field you must have the manageUserAndRoles capability.

firstName String Yes

First name of the user. If the caller has manageUsersAndRoles capability, this field can be updated for any user. If the caller does NOT have manageUsersAndRoles capability, then only the calling user's firstName can be updated.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.