API People Patch v3

Contents:

Expand all Collapse all

For the latest updates on available API endpoints and documentation, see api.trifacta.com.

As of Release 6.4, the v3 APIs are End of Life (EOL). Before using this release or a later one, you should migrate to using the latest available API version. For more information, see API Version Support Matrix.
Latest version of this endpoint: API People Patch v4.

Contents:

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

Version: v3

Required Permissions

The authenticated user must be an admin.

NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.4/index.html#section/Authentication.

Request

Request Type: PATCH

Endpoint:

/v3/people/<id>

where:

Parameter	Description
`<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.

Send Feedback

Page tree

API People Patch v3

Required Permissions

Request

Response

Reference