D toc |
---|
Retrieve the platform account information for a user specified by userId.
Version: v3
Required Permissions
The authenticated user must be an admin.
D s api auth |
---|
Request
Request Type: GET
Endpoint:
Code Block |
---|
/v3/people/<id> |
where:
Parameter | Description |
---|---|
<id> | Internal identifier of the user to retrieve. |
Request URI - Example:
Code Block |
---|
/v3/people/2 |
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
Code Block |
---|
{ "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
Property | Description |
---|---|
outputHomeDir | Home directory where the user's generated results are written |
id | Internal user identifier |
Email address (and loginId) for the user | |
name | Display 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 Hadoop cluster |
cpPrincipal | (If enabled) Principal value used to integrate with cloud platform |
isAdmin | If true , the user account is an administrator account. |
isDisabled | If true , the account is disabled. |
lastLoginTime | Timestamp for the last time that the user logged in |
createdAt | Timestamp for when the user account was created |
updatedAt | Timestamp 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 |