Page tree

Release 6.0.2



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

This is the latest version of the APIs.


Retrieve 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 Designer Cloud Powered by Trifacta® platform must include authentication credentials. See


Request Type: GET




<id>Internal identifier of the user to retrieve.

Request URI - Example:


Request Body:



Response Status Code - Success:  200 - OK

Response Body Example:

    "id": 2,
    "email": "",
    "name": "Joe Guy",
    "ssoPrincipal": null,
    "hadoopPrincipal": null,
    "isAdmin": false,
    "isDisabled": false,
    "forcePasswordChange": false,
    "state": "active",
    "lastStateChange": null,
    "createdAt": "2019-02-12T09:04:52.073Z",
    "updatedAt": "2019-02-12T09:04:52.073Z",
    "outputHomeDir": "/trifacta/queryResults/",
    "fileUploadPath": "/trifacta/uploads",
    "lastLoginTime": "2019-05-19T10:53:11.014Z",
    "awsConfig": null


idInternal user identifier
emailEmail address (and loginId) for the user
nameDisplay name for the user
ssoPrincipal(If SSO is enabled) Principal value of the user for single-sign on
hadoopPrincipal(If secure impersonation is enabled) Hadoop principal value for the user, which determines permissions on the cluster
isAdminIf true, the user account is an administrator account.
isDisabledIf true, the account is disabled.
forcePasswordChange(if enabled) When set to true, the user must change the account password on next login.

Current state of the user account:

  • active - user is active and usable in the workspace
  • hidden - user account has been hidden from use.
lastStateChangeTimestamp for when the value of the state parameter was changed.
createdAtTimestamp for when the user account was created
updatedAtTimestamp for when the user account was last modified
outputHomeDirHome directory where the user's generated results are written
fileUploadPathPath on backend datastore where files uploaded from the user's desktop are stored for use as imported datasets.
lastLoginTimeTimestamp for when the user last logged in to the product.
awsConfig(If AWS integration is enabled) Value contains the S3 credentials, default bucket, and any extra buckets to which the user has access

For more information on roles, see Manage Users.

This page has no comments.