URL Parameters and Possible Responses

Turning off Dry Run

Dry Run is the ability to run the process of generating and storing the operations to remove user licenses in Pluralsight without applying those operations within Pluralsight. This allows for a review of the data to ensure everything would appear as expected before making permanently removing user licenses.

Note: The default behavior for this dryRun is true. This means that if you don't set dryRun to false it will default to not applying the changes in Pluralsight. It will return the generated operations that would be necessary for removing user licenses

To apply the generated operations and officially provision licenses in Pluralsight, add ?dryRun=false to the end of your endpoint url.


Turning On Strict Mode (ExitOnError)

Strict mode is the ability to force the provision process to stop upon encountering any errors. This is likely most helpful when initially setting up and testing the provision process. Without strict mode, the file validation process will document and then remove any records that would cause errors and move forward with the rest of the data to run the provision. Strict Mode will stop the process from moving forward upon receiving any errors and not attempt to run the provision of the specified users.

Regardless of whether you are using strict mode or not, the results of the validation and sync process can be viewed within the License Provision Results.

Note: The default behavior for this exitOnError is false. This means that if you don't set exitOnError to true it will default to removing the users that are causing the errors from the files and continuing with the rest of the validation and provision process.

To turn on strict mode and stop the process whenever errors occur, add ?exitOnError=true to the end of your endpoint url.


Product IDs

The productIds URL paramter allows you to pass in the specific ID's that you want assigned to the list of users that you provide us in the CSV file. This does not replace or remove any prexisting product licenses a user may already have, it just adds the new one products to the user (To strip user licesnes, please visit our Licenses Deprovisioning docs). There is no limit to how many product ID's you can pass into this parameter, but it must be a comma sperate string (?productIds=1,2,3).

Possible Responses

No files were submitted

Copy

{
	“status”: "No files",
}

Status Code: 400


In Progress

Copy

{
	“status”: “Processing”,
}

Status Code: 200


Validation Errors

Copy

{
	“status”: "Validation Completed With Errors",
}

Status Code: 400


Provision Errors

Copy

{
	“status”: "Completed With Errors",
}

Status Code: 400


Success

Copy

{
	“status”: "Completed Successfully",
}

Status Code: 200


Full Example

Copy

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