feat: add SSO, SCIM and Magic Link documentation - #392
Conversation
Add documentation for setting up SSO, setting up SCIM and using Magic Link
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @FayeSGW's task in 3m 38s —— View job Doc review — PR #392
Two findings are inline on
|
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
| <Step title="Create your IdP groups and add your users"> | ||
| Create a group in your IdP for each Kosli organization and role you need, then add your users to them. See | ||
| [Roles for new and existing users](#roles-for-new-and-existing-users) for the group naming scheme, and for | ||
| how to map those groups to Kosli roles. | ||
| </Step> | ||
| <Step title="Trigger a provisioning cycle"> | ||
| Once your users are in the right groups and you have triggered a provisioning cycle within your IdP, | ||
| changes to your users within the IdP are reflected in Kosli. | ||
| </Step> |
There was a problem hiding this comment.
Improvement — the procedure's step order and the page's own warning disagree about when to sync.
The <Steps> block ends at "Trigger a provisioning cycle", but group → role mapping is documented after this block, in Map your IdP groups to Kosli roles (line 90). Line 78-80 then says the opposite of what the steps imply:
A full or forced sync in your IdP … provisions every assigned user at once, not only the ones you have just changed, so make sure your groups and role mappings are correct before you trigger one.
An admin following the numbered steps top-to-bottom triggers the first sync at step 4 — before they have mapped any IdP group to a Kosli role, and before they have read the warning. Given the same page says the IdP becomes authoritative for every provisioned user (line 109-112), getting that order wrong is expensive to unwind.
Making the mapping an explicit step before the sync would remove the trap, e.g. insert a step after "Create your IdP groups and add your users":
Map your groups to Kosli roles — follow Map your IdP groups to Kosli roles before you sync. The first sync provisions every assigned user at once.
| <Step title="Open the wizard and select SCIM Configuration"> | ||
| Open the link from your Customer Success representative and select the **SCIM Configuration** box on the | ||
| first screen. | ||
|
|
||
| <Frame> | ||
| <img src="/images/administration/scim-setup-wizard.png" alt="Start page for the SSO and SCIM setup suite wizard" /> | ||
| </Frame> |
There was a problem hiding this comment.
Suggestion — the screenshot shows the state after this step, not the state the reader is in.
images/administration/scim-setup-wizard.png shows both cards already reading ✓ Configured (SSO Configuration (OIDC) and SCIM Configuration, both for Azure Entra ID). A reader arriving to set SCIM up for the first time sees the SCIM card with a + Add action instead — the same shape as add-sso.png on the SSO page, which correctly shows the pre-setup state.
Either capture the screen before SCIM is configured, or add a line saying the card shows + Add until the connection exists (and Configured afterwards), so nobody concludes they are looking at the wrong wizard.
Add documentation for setting up SSO, setting up SCIM and using Magic Link