How to use the new SCIM endpoint
Who can use this feature
- Supported on certain tiers of Enterprise plans. Contact your CSM if you don't have access.
- Anyone with an org admin role can access and EDIT SCIM settings
Recently we released a new API endpoint for the WRITER SCIM connection. This new endpoint enabled IdP group mapping. To take advantage of these upgraded features, follow the steps below to update your SCIM connection and map IdP groups. If you’ve never set up a SCIM connection with your WRITER account, see the full SCIM instructions here.
In this article:
What's changing with the new SCIM endpoint?
The new SCIM endpoint unlocks the ability to map different IdP groups to role/team combinations.
SCIM users without a role defined under IdP groups will receive the default role assigned to their domain under Admin > Access & provisioning in the Access tab. SCIM-synced users default to the team and role set in the Access tab, unless IdP group mapping specifies otherwise.
All roles will now come from the group sync instead of user attributes. Users that have been set to a specific role via ATTRIBUTES will also need to be mapped via groups instead. You'll need to re-push all existing groups from your IdP post-upgrade.
All users require a team. Be sure to map each IdP group to a role and team in the next step, including a group for org admins.
How to upgrade the SCIM API endpoint
To access SCIM settings, go to Admin > Access & provisioning. Next, select the SCIM tab and then select Upgrade.
From here, you will be upgraded to the new flow! You'll need to re-push all your existing groups from your IdP in order to map them to new roles and teams. Any new groups will show up automatically. Any groups not mapped here will revert to the default role/team configured.
From the dropdowns, select the Team and Role to assign to each group. Then select Complete upgrade to finish this process.
Finally, you’ll be taken to the IdP groups tab where you’ll see the confirmation message that your endpoint has been updated in the bottom right corner. From this page, you can edit your IdP group role mapping by selecting the Edit button. To learn more about IdP groups, see our article on setting up SCIM provisioning here.