Updates the platform account information for a user specified by userId.  

Version: v3

Required Permissions

The authenticated user must be an admin.

Request

Request Type: PATCH

Endpoint:

/v3/people/<id>

where:

ParameterDescription
<id>Internal identifier of the user to update.

Request URI - Example:

/v3/people/2

Request Body:

{
  "outputHomeDir": "/trifacta/queryResults/joe@example.com",
  "email": "joe@example.com",
  "name": "Joe Example",
  "ssoPrincipal": null,
  "hadoopPrincipal": null,
  "cpPrincipal": null,
  "isAdmin": false,
  "isDisabled": false,
  "awsConfig": null
}

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
  "id": 2,
  "updatedAt": "2017-05-18T19:46:46.839Z"
}

Reference

For more information on these properties, see API People Get v3.