Skip to main content
Closed Beta: The SCIM API is currently in Closed Beta and requires an Enterprise license.

Managing Users via SCIM

If you need to troubleshoot your identity provider’s connection, it helps to understand what happens under the hood. Here is how your provider manages users in Collabase.

1. View all users

When your provider checks which users are currently synchronized, it requests a list from Collabase. Endpoint: GET /api/scim/v2/Users Your provider can also filter this list to find specific employees (e.g., searching by email address) or load users in smaller pages if your company is very large.

2. Create a new user

When you assign a new employee to Collabase in your identity provider, it sends their details to this endpoint. Endpoint: POST /api/scim/v2/Users If a Collabase account with the exact same email address already exists, we will automatically link the existing account to your identity provider. No data will be lost.
Required Fields: Your identity provider must always send the user’s email address, first name, and last name. If these are missing, the user cannot be created.

3. Update or deactivate a user

If a user changes their name or leaves the company, your provider will send an update. Endpoint: PATCH /api/scim/v2/Users/{id} To deactivate a user without losing their data, your provider will send an update setting their status to inactive. They will immediately lose access to Collabase, but their documents and tasks remain safe.

4. Permanently delete a user

If you completely remove a user from your directory, your provider might try to delete them. Endpoint: DELETE /api/scim/v2/Users/{id}
Danger: This will permanently remove the user and their personal data from Collabase. This cannot be undone. We strongly recommend configuring your identity provider to deactivate users instead of deleting them.