Page tree

 

This is the latest version of the APIs.

Contents:


Returns a list of all users of the platform.

Version: v4

Required Permissions

 

NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.

Request

Request Type: GET

Endpoint:

/v4/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:

/v4/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 Example:

{
    "data": [
        {
            "id": 4,
            "email": "test@example.com",
            "name": "Test1",
            "ssoPrincipal": null,
            "hadoopPrincipal": null,
            "isAdmin": false,
            "outputHomeDir": "/trifacta/queryResults/test@example.com",
            "isDisabled": false,
            "forcePasswordChange": false,
            "state": "active",
            "lastStateChange": null,
            "createdAt": "2019-01-09T20:23:31.560Z",
            "updatedAt": "2019-01-09T20:25:03.000Z",
            "fileUploadPath": "/trifacta/uploads",
            "lastLoginTime": "2019-05-23T10:22:44.532Z",
            "awsConfig": null
        },
        {
            "id": 3,
            "email": "95203645@example.com",
            "name": "Test User95203645",
            "ssoPrincipal": null,
            "hadoopPrincipal": null,
            "isAdmin": false,
            "outputHomeDir": "/trifacta/queryResults/95203645@example.com",
            "isDisabled": false,
            "forcePasswordChange": false,
            "state": "active",
            "lastStateChange": null,
            "createdAt": "2019-01-09T10:39:50.310Z",
            "updatedAt": "2019-01-09T10:39:50.349Z",
            "fileUploadPath": "/trifacta/uploads",
            "lastLoginTime": "2019-05-24T12:12:45.581Z",
            "awsConfig": null
        },
        {
            "id": 2,
            "email": "83466845@example.com",
            "name": "Test User83466845",
            "ssoPrincipal": null,
            "hadoopPrincipal": null,
            "isAdmin": false,
            "outputHomeDir": "/trifacta/queryResults/83466845@example.com",
            "isDisabled": false,
            "forcePasswordChange": false,
            "state": "active",
            "lastStateChange": null,
            "createdAt": "2019-01-09T09:21:13.501Z",
            "updatedAt": "2019-01-09T09:21:13.548Z",
            "fileUploadPath": "/trifacta/uploads",
            "lastLoginTime": "2019-05-22T07:11:24.921Z",
            "awsConfig": null
        },
        {
            "id": 1,
            "email": "admin@example.com",
            "name": "Administrator",
            "ssoPrincipal": null,
            "hadoopPrincipal": null,
            "isAdmin": true,
            "outputHomeDir": "/trifacta/queryResults/admin@example.com",
            "isDisabled": false,
            "forcePasswordChange": false,
            "state": "active",
            "lastStateChange": null,
            "createdAt": "2019-01-09T08:40:02.555Z",
            "updatedAt": "2019-01-09T08:40:02.647Z",
            "fileUploadPath": "/trifacta/uploads",
            "lastLoginTime": "2019-05-21T04:11:09.421Z",
            "awsConfig": null
        }
    ]
}

Reference

For more information on the properties of a user, see API People Get v4.

 

This page has no comments.