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 deprovision 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 deprovision process to stop upon encountering any errors. This is likely most helpful when initially setting up and testing the deprovision 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 deprovision. Strict Mode will stop the process from moving forward upon receiving any errors and not attempt to run the deprovision 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 Deprovision Results for Workday.

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 deprovision process.

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


Turning off Remove Users

By default, the License Deprovision endpoint will remove users from a plan. If you want to retain your users and only remove their licenses, you must set the removeUsers flag to false.

To turn off remove users, add ?removeUsers=false to the end of your endpoint url.


Turning on Retain Privileges

If you have the removeUsers flag set to false, the License Deprovision endpoint will strip privileges from a user when it removes their license. For example, if a user has managerial privileges, during this process it will strip their manager status and then deprovision them. If you wish for your users to retain their privileges, you must set the retainPrivileges flag to true.

Note: The default behavior for this retainPrivileges is false. This means that if you don't set retainPrivileges to true it will default to removing the users managerial privileges. You must also set the removeUsers parameter to false, or the retainPrivileges parameter will be ignored.

To turn on retain privileges, add ?retainPrivileges=true&removeUsers=false to the end of your endpoint url.


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


Deprovision Errors

Copy

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

Status Code: 400


Success

Copy

{
	“status”: "Completed Successfully",
}

Status Code: 200


Full Example

Copy

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