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}

JWT

organization:user:update

Parameters

Name	Type	In	Description
organizationId*	string	path
id*	string	path	Unique identifier for the organization user.

Request Body Schema

Property	Type	Description	Constraints
firstName	string	First name of the user. //	min: 1, max: 256
lastName	string	Last name of the user.	min: 0, max: 256
email	string	Email address of the user.	min: 1, max: 256, format: email
role	string	Role of the user.	min: 1, max: 256
userGroupIds	array	List of unique identifiers for the user groups.	items: string
allowCustomerPortalAccess	boolean	Allow customer portal access.

Request Example

{
  "firstName": "string",
  "lastName": "string",
  "email": "user@example.com",
  "role": "string",
  "userGroupIds": [
    "string"
  ],
  "allowCustomerPortalAccess": true
}

Triggers webhook: organization.user.updated

POST <your-webhook-url>
{
  "event": "organization.user.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "role": "string",
    "twoFactorEnabled": true,
    "googleSsoEnabled": true,
    "lastLoginAt": "2019-08-24T14:15:22Z",
    "userGroups": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "description": "string"
      }
    ]
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "role": "string",
  "twoFactorEnabled": true,
  "googleSsoEnabled": true,
  "lastLoginAt": "2019-08-24T14:15:22Z",
  "userGroups": [
    {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "description": "string"
    }
  ]
}