Page tree

Enterprise Release 6.4.2

Latest Release 8.2
This Page Release 6.4



For the latest updates on available API endpoints and documentation, see

This is the latest version of the APIs.


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

Version: v4

Required Permissions

The authenticated user must be an admin.

NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.


Request Type: PATCH




<id>Internal identifier of the user to update.

Request URI - Example:


Request Body:

NOTE: For the PATCH method, only the properties that are being patched need to be submitted.

    "outputHomeDir": "/trifacta/queryResults/",
    "email": "",
    "name": "Joe Example",
    "ssoPrincipal": null,
    "hadoopPrincipal": null,
    "isAdmin": false,
    "isDisabled": false,
    "forcePasswordChange": true,
    "awsConfig": null

Request Body Example - Disable User

You can use the following request to disable the specified user. This request also removes the admin role from the user.

    "isAdmin": false,
    "isDisabled": true


Response Status Code - Success:  200 - OK

Response Body Example:

  "id": 6,
  "updatedAt": "2018-01-24T23:49:08.199Z"


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


This page has no comments.