Page tree

 

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 Get v4.

Contents:


Retrieve 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 Trifacta® platform must include authentication credentials. See API Authentication.

Request

Request Type: GET

Endpoint:

/v3/people/<id>

where:

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

Request URI - Example:

/v3/people/2

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
  "outputHomeDir": "/trifacta/queryResults/foo@trifacta.com",
  "id": 2,
  "email": "foo@trifacta.com",
  "name": "foobar379216291",
  "ssoPrincipal": null,
  "hadoopPrincipal": "foo",
  "cpPrincipal": null,
  "isAdmin": false,
  "isDisabled": false,
  "lastLoginTime": "2017-01-27T23:24:54.930Z",
  "createdAt": "2017-01-12T00:37:03.138Z",
  "updatedAt": "2017-01-27T23:24:54.936Z",
  "awsConfig": null
}

Reference

PropertyDescription
outputHomeDirHome directory where the user's generated results are written
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
cpPrincipal(If enabled) Principal value used to integrate with cloud platform
isAdminIf true, the user account is an administrator account.
isDisabledIf true, the account is disabled.
lastLoginTimeTimestamp for the last time that the user logged in
createdAtTimestamp for when the user account was created
updatedAtTimestamp for when the user account was last modified
awsConfig(If AWS integration is enabled) Value contains the S3 credentials, default bucket, and any extra buckets to which the user has access

 

 

This page has no comments.