Latest version of this endpoint: API People Get List v4.
Contents:
Returns a list of all users of the platform.
Version: v3
Required Permissions
- If you are not logged in or are logged as a non-admin user, you can retrieve a very limited set of properties for each user.
- If you are logged in as an admin, you can retrieve the full property set for each user.
Request
Request Type: GET
Endpoint:
/v3/people
Endpoint with paged retrieval:
By default, this endpoint returns results in sets of 25.
You can apply query parameters to change the size of the default set and to page through result sets. The following example queries for results 100 at a time. In this case, the query asks for results 3-102:
/v3/people?limit=100&offset=2
If the count of retrieved results is less than the limit, you have reached the end of the results.
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Examples:
When not logged in, or logged in as a non-admin user:
{
"data": [
{
"name": "ExampleUser",
"email": "joe@example.com",
"id": 955
},
{
"name": "Example User 2",
"email": "jim@example.com",
"id": 888
}
]
}
When logged in as an admin:
{
"data": [
{
"outputHomeDir": "/trifacta/queryResults/joe@example.com",
"id": 955,
"email": "joe@example.com",
"name": "ExampleUser",
"ssoPrincipal": null,
"hadoopPrincipal": "ExampleUser",
"cpPrincipal": null,
"isAdmin": false,
"isDisabled": false,
"lastLoginTime": null,
"createdAt": "2017-01-25T23:22:36.707Z",
"updatedAt": "2017-01-25T23:22:36.707Z",
"awsConfig": null
},
{
"outputHomeDir": "/trifacta/queryResults/jim@example.com",
"id": 888,
"email": "jim@example.com",
"name": "Example User 2",
"ssoPrincipal": null,
"hadoopPrincipal": null,
"cpPrincipal": null,
"isAdmin": false,
"isDisabled": false,
"lastLoginTime": null,
"createdAt": "2017-01-25T21:38:59.537Z",
"updatedAt": "2017-01-25T21:38:59.537Z",
"awsConfig": null
}
]
}
Reference
For more information on the properties of a user, see API People Get v3.
This page has no comments.