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

Version: v4

Required Permissions

The authenticated user must be an admin.

Request

Request Type: GET

Endpoint:

/v4/people/<id>

where:

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

Request URI - Example:

/v4/people/4

Query parameter reference:

The following query parameters can be submitted with this endpoint:

The following parameters are supported specifically for this endpoint:

Query ParameterData TypeDescription

preventNameFetch

stringIf true, Name and emailAddress values are not returned.
uuidstringUniversal user identification value
workspaceIdstringWorkspace identifier. This value is typically 1.


For more information, see API Common Query Parameters v4.

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
    "id": 2,
    "email": "joe@example.com",
    "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/joe@example.com",
    "fileUploadPath": "/trifacta/uploads",
    "lastLoginTime": "2019-05-19T10:53:11.014Z",
    "awsConfig": null
}

Reference

PropertyDescription
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 provider
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.
state

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.