Publish provisioned users

This endpoint is used to add 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

POST https://public-api.productiv.com/services/push/v1/customer/apps/{appId}/users
Required Scope https://api.productiv.com/connector.write

Request 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 pushed.

Request body

Property Datatype Description Optional
provisionedUsers array List of ProvisionedUser objects (see definition below) No

Example request body

{
  "provisionedUsers": [
    {
      "appUserId": "109282355904833424637",
      "email": "testuser@random.com",
      "username": "testuser",
      "license": "Pro"
    }
  ]
}

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.

Example response

{
  "success": true
}

API limitations

  • Add maximum of 1000 provisioned users at a time

SLA

  • Any changes to user provisioning will be reflected for any data aggregations run for after 24 hours of the change date
  • All users added by this API are considered provisioned

Objects

ProvisionedUser

Every provisioned user should have the following properties in the object:

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