Update User

PUT /auth/users/{userId}

Update a specific userId in the caller's org

• User action signature required. See User Action Signing for more information.

• Request headers required. See Request Headers for more information.

• Authentication required. See Authentication Headers for more information.

Required Permissions

Name	Conditions
Auth:Users:Update	Always Required
Auth:Types:Employee	When target user's kind is CustomerEmployee
Auth:Types:EndUser	When target user's kind is EndUser

Parameters

userId *

the ID of the user to update

Example

/auth/users/us-em7bu-m6c48-hdqoobj7dj24pko

Request Body

publicKey	String	Optional a PGP public key that is used to encrypt emails going to the new user
externalId	String	Optional a user defined value that can be used to correlate the entity with an external system

Example

{
  "external": "my_internal_id"
}

Responses

• See Common Errors for common errors.

• See User Management Errors for user management specific errors.

200

Success - The user that was updated

{
  "username": "[e-mail]",
  "userId": "us-2mhcm-9r90a-92ran47bjpl60hmv",
  "kind": "CustomerEmployee",
  "credentialUuid": "cr-4uc9u-12ij1-9s08327e73jqqcnr",
  "orgId": "or-yanke-mars-6ulofamogg84s87v",
  "permissions": [],
  "scopes": [],
  "isActive": true,
  "isServiceAccount": false,
  "isRegistered": false,
  "permissionAssignments": []
}