Getting Started with License Deprovisioning

In this article:

• Overview
• Recommended steps
• Recommended testing strategies

The License Deprovisioning endpoint allows you to revoke users' licenses. It operates independently from the Team Hierarchy and provides a quick, efficient way to remove users' licenses and/or managerial privileges upon termination or under other specific circumstances.

This page walks you through the complete setup of the License Deprovisioning API. You’ll find detailed documentation about its functionality, step-by-step guidance on setting up your HTTP request, recommended testing strategies, and troubleshooting tips.

Recommended steps

1. Familiarize yourself with the authentication requirements on the Authentication page.
2. Follow the setup instructions:
   • General setup: Navigate to the License deprovision setup page. This page will explain step by step about how to set up your HTTP request with license deprovisioning.
3. Test your setup
   • Follow the recommended testing strategy below to verify that your setup is functioning correctly.
4. Review results and troubleshoot errors:
   • General review: Check the results on the License deprovision results page and refer to the troubleshooting section there for any issues encountered.

Recommended testing strategies

Follow these phased steps to ensure a smooth testing process:

1. Run initial derovision job with dry run

   • Set the dryRun URL parameter to true to simulate the deprovision without applying changes.
   • Optional: Use strict mode to halt the process if any errors occur. Refer to the Strict mode (ExitOnError) section of License deprovisioning setup page.

2. Review results

   • Check the Deprovision Results page for any errors or warnings.
   • Review the list of operations generated by the dry run.
   • Ask yourself:
     • Is the total number of deprovisioned users within the estimated range?
     • Is the total number of managers removed as expected?

3. Troubleshoot if necessary

   • If the number of operations generated isn’t as expected:
     • Click the gray "View All" button on the results page to review detailed in-depth results.
     • Use these insights to diagnose and fix any issues.

4. Proceed after review

   • Once satisfied with the dry run results, move on to the next steps.

5. Final deprovision run

   • Set the dryRun URL parameter to false to apply the deprovision process.
   • Send the entire data set for deprovisioning.
   • Review the final results for any issues.

6. Automate to production

   • Determine the frequency of automated deprovisioning based on your use case needs.