Get provisioned users

This endpoint is used to get a list of provisioned users for an application in Productiv. Productiv will always treat the set of provisioned users updated by the developer APIs as the current list of all users for the application.

Prerequisites

Before this API can be queried, you should have already set up the application for which you will be publishing provisioned users. Once thats done you should have a unique appId that can be used to query these APIs. To see how to set up an application checkout Set up an Application.
In order to query this API, you would also need to send an access_token as part of the Authorization header. To see the steps for generating an access token check out Authorization.

Endpoint

GET https://public-api.productiv.com/services/push/v1/customer/apps/{appId}/users

Required Scope https://api.productiv.com/connector.write

Requset headers

Parameter	Value
content-type	application/json
Authorization	`Bearer access_token`

Path Params

Parameter	Description
appId	`appId` represents the App for which the provisioned users are being retrieved.

Query Params

Parameter	Description
nextPageToken	Opaque token that can be specified to get the next page of provisioned users from the last request

Pagination

This API will retrieve maximum of 1000 users at a time. All subsequent calls to get more users must be called with the nextPageToken provided in the response.

Response

If the request is successful, a JSON response will be returned. This JSON object will contain the following parameters:

Parameter	Description
success	Will be set to `true` in case of a successful response.
provisionedUsers	List of ProvisionedUser objects (see definition below)
nextPageToken	Token to retrieve next page of users from current request. Null if no next page.
numUsers	The number of users in this page of provisioned users

Example response

{
  "numUsers": 1,
  "success": true,
  "provisionedUsers": [
    {
      "appUserId": "109282355904833424637",
      "email": "testuser@random.com",
      "username": "testuser",
      "license": "Pro"
    }
  ],
  "nextPageToken": null
}

SLA

Any changes to user provisioning will be reflected for any data aggregations for 24 hours after the change date

Objects

ProvisionedUser

Property	Datatype	Description	Optional
email	String	Email of the provisioned user	No
appUserId	String	User Id of the provisioned user for the specified application	No
username	String	Username of provisioned user	Yes
license	String	License associated with this provisioned user	Yes