Integrations Hub

Trusted solutions built for a changing world

LMS/LXP

HRIS

Data Analytics

Build Your Own Integrations

LMS/LXP

HRIS

Data Analytics

Build Your Own Integrations

Setup

In this article:


Post method

This section describes how to provision users by submitting a CSV file to Pluralsight. By default, the process runs as a "dry run," meaning no changes are applied until the dryRun parameter is set to false.


API request details


API requests should be delivered to an endpoint appended to the production URL https://integrations-api.pluralsight.com.


SectionDetails
EndpointPOST /provision
HTTP methodPOST
DescriptionSubmit a CSV file containing all users to provision in Pluralsight. By default, it's a dry run, and user license removal operations are not applied. To apply operations, set dryRun to false.
Headers

Content-Type: text/csv

Content-Disposition: attachment; filename="provision.csv"

Body

Provide either the provision.csv file as described below.

Provision CSV file

File Name: provision.csv

Required CSV Headers:

  • id
  • email
  • first_name
  • last_name

Each user must have a unique id (preferably the same id used for SSO integration with Pluralsight).


Note: Filter out users missing id or email fields; these are required and will cause errors. Ensure that all users have unique id and email. Avoid special characters in the file (e.g., quotation marks, commas, symbols) to prevent parsing errors.


URL parameters and responses


Product IDs


What It Does:

  • The productIds parameter allows you to specify which product licenses to assign to users in your CSV file. This adds new product licenses without removing any existing ones.

How to Use:

  • Pass a comma-separated list of product IDs via the productIds parameter.

Example URL:

  • https://integrations-api.pluralsight.com/provision?productIds=1,2,3

Dry run (dryRun)


What It Does:

  • Dry Run lets you generate and store the operations to add user licenses without actually applying the changes in Pluralsight. This allows you to review the data to ensure everything would appear as expected.

Default Setting:

  • true (meaning changes are not applied by default)

How to Use:

  • To apply changes, add ?dryRun=false to the end of your endpoint URL.

Example URL:

  • https://integrations-api.pluralsight.com/provision?dryRun=false

Strict mode (exitOnError)


What It Does:

  • Strict Mode forces the provisioning process to stop if any errors occur. Without Strict Mode, the process continues, skipping any users that cause errors.

Default Setting:

  • false (meaning the process continues without stopping even if errors occur)

How to Use:

  • To turn on Strict Mode and stop the process when errors are encountered, add ?exitOnError=true to the end of your endpoint URL.

Example URL:

  • https://integrations-api.pluralsight.com/provision?exitOnError=true

Possible responses


StatusMessageCode
No files submitted{"status": "No files"}400
In progress{"status": "Processing"}200
Validation errors{"status": "Validation Completed With Errors"}400
Provision errors{ "status": "Completed With Errors" }400
Success{"status": "Completed Successfully"}200

Full example:

curl 
  -T provision.csv 
  -X POST 
  -H "Authorization: Bearer [insert-your-api-key-here]" 
  -H 'Content-Disposition: attachment; filename="provision.csv"' 
  -H "Content-Type: text/csv" 
  https://integrations-api.pluralsight.com/provision