info
This app connector is in a Beta state.
Provisioned users
Updated: Sep. 11, 2023
The Provisioned Users List API enables you to programmatically fetch your company's complete list of provisioned users of an application for a particular data source.
Prerequisites
Querying the Data Export APIs involves sending an access_token as part of the Authorization header. For instructions on how to generate an access token, see Authorization.
Endpoint
GET |
https://public-api.productiv.com/pull/v1/apps/:applicationId/users |
Required Scope |
https://api.productiv.com/users.read |
Parameter |
Value |
content-type |
application/json |
Authorization |
Bearer access_token |
Path Params
Parameter |
Description |
applicationId |
Unique identifier for the App for which users are being requested. These IDs are provided in the App List endpoint |
Query params
Parameter |
Description |
Optional |
asOfDate |
Date as of which information is being provided, in YYYY-MM-DD format. Must be on or later than 2023-08-23 |
No |
dataSource |
Data Source to query users for (one of "Engagement", "Managed SSO", or "Unmanaged SSO") |
No |
rollingWindow |
Timeframe to compute activity status from (one of 1, 7, 30, 60, or 90). Defaults to 30 |
Yes |
after |
Pagination cursor for the next page of users |
Yes |
Response
If the request is successful, a JSON response is returned. The JSON object contains the following parameters:
Parameter |
Datatype |
Description |
Users |
array |
List of User objects (see definition below) |
Count |
number |
Number of users returned in the Users array |
After |
string |
Pagination cursor for the next page of users, to be used in a subsequent API call. Only returned if there are more results to be returned |
Example response
{
"Users": [
{
"ApplicationId": "foo",
"ApplicationInstanceId": "bar",
"Email": "john.smith@baz.com",
"FirstName": "John",
"LastName": "Smith",
"Status": "Active",
"Team": "Services",
"JobTitle": "Services",
"Location": "Irvine, California",
"Manager": "jane.doe@baz.com",
"ProvisionedDate": "2020-08-24"
},
...
],
"After": "QmUgUHJvZHVjdGl2IQ==",
"Count": 100
}
Objects
User Object
The User object represents a single user provisioned to an application.
Parameter |
Datatype |
Description |
ApplicationId |
string |
Unique identifier for the application |
ApplicationInstanceId |
string |
Unique identifier for an instance of an application |
Email |
string |
Email address of the provisioned user |
FirstName |
string |
First name of the provisioned user |
LastName |
string |
Last name of the provisioned user |
Status |
string |
Whether or not the user was actively using this application within the rolling window; either "Active" or "Inactive" |
Team |
string |
Team that the provisioned user belongs to |
JobTitle |
string |
Provisioned user's job title |
Location |
string |
Working location of the provisioned user |
Manager |
string |
Email address of the provisioned users's manager |
ProvisionedDate |
string |
Date on which this user was provisioned with this application |