Deprovision a SaaS identity
Remove an employee’s identity from a SaaS application.
Depending on the SaaS application capabilities, the deprovisioning is either handled automatically (via API integration) or manually (a deprovisioning ticket is created for an admin to complete).
The response indicates which path was taken via the provisioningType field.
An application offering several deprovisioning actions (suspend, delete, do nothing) takes deprovisioningStrategy.action; without it, the company default for that application applies, and with no default the call answers 400 with the available actions. Moving documents or emails to another account goes through createSaasProvisioningIntent instead.
Authorizations
Use your Primo API key in the Authorization header as Bearer <API_KEY>.
Path Parameters
Body
The ID of the identity to deprovision. Retrieve it from getSaasById → identities[].id.
1Read only for an application that offers several deprovisioning actions (an identity provider such as Google Workspace or Microsoft Entra). Left out there, the action the company set for that application in its offboarding settings applies; with none set, the call answers 400 and names the available actions.
Response
Whether the deprovisioning was handled automatically via API or a manual ticket was created.
automatic, manual