In this article:
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 requests should be delivered to an endpoint appended to the production URL https://integrations-api.pluralsight.com
.
Section | Details |
---|---|
Endpoint | POST /provision |
HTTP method | POST |
Description | Submit 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: Content-Disposition: |
Body | Provide either the |
Provision CSV file | File Name: Required CSV Headers:
Each user must have a unique |
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.
What It Does:
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:
productIds
parameter.Example URL:
https://integrations-api.pluralsight.com/provision?productIds=1,2,3
What It Does:
Default Setting:
true
(meaning changes are not applied by default)How to Use:
?dryRun=false
to the end of your endpoint URL.Example URL:
https://integrations-api.pluralsight.com/provision?dryRun=false
What It Does:
Default Setting:
false
(meaning the process continues without stopping even if errors occur)How to Use:
?exitOnError=true
to the end of your endpoint URL.Example URL:
https://integrations-api.pluralsight.com/provision?exitOnError=true
Status | Message | Code |
---|---|---|
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 |
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