docs: add blank authentication and user provisioning pages - #382
docs: add blank authentication and user provisioning pages#382mintlify[bot] wants to merge 20 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Claude finished @gsavage's task in 3m 54s —— View job Doc quality reviewAll three new pages are listed in Four findings are posted inline. One more, which falls outside the diff hunks so GitHub won't take an inline comment:
|
Fill in the Single Sign On page with the setup-wizard screenshots and bring it into line with the conventions in CLAUDE.md. The three <<insert ... image>> placeholders become <Frame> embeds, matching the in-house style used elsewhere in the repo. The four numbered step headings become a <Steps>/<Step> block, as CLAUDE.md asks for sequential procedures and as the sibling service accounts page already does. The doc's own step numbering is intentionally independent of the wizard's page count, which varies with what the user enters. Also fix a duplicated word in the "Enabling Single Sign On" heading, two British spellings (one of which, "organisation", is an error-level Vale violation), sentence-case the step titles, bold the UI labels, and replace curly apostrophes and a hyphen-as-dash. The six authentication screenshots move into images/administration/, since CLAUDE.md asks for images to live in an appropriate subdirectory rather than the images/ root.
Link the SCIM provisioning page from the OIDC/SAML choice in the SSO setup wizard, and note on the roles page that SCIM-provisioned users' roles cannot be changed in Kosli. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
| <Frame><img src="/images/administration/magic-link-enter-email.png" alt="Kosli sign-in page with an email address entered and the Continue with SSO button" /></Frame> | ||
| </Step> | ||
| <Step> | ||
| Kosli then sends you an email containing the link and ask you to check your inbox |
There was a problem hiding this comment.
Improvement — subject–verb disagreement, and the sentence has no full stop. "Kosli then sends you an email … and ask you to check your inbox" should be "asks". This is the only one of the three <Step> bodies on the page that doesn't terminate.
| Kosli then sends you an email containing the link and ask you to check your inbox | |
| Kosli then sends you an email containing the link and asks you to check your inbox. |
| icon: "wand-magic-sparkles" | ||
| --- | ||
|
|
||
| Magic Link is a way of signing into Kosli without needing to setup [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. |
There was a problem hiding this comment.
Improvement — "setup" is the noun; the verb is "set up".
| Magic Link is a way of signing into Kosli without needing to setup [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. | |
| Magic Link is a way of signing into Kosli without needing to set up [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. |
| @@ -0,0 +1,47 @@ | |||
| --- | |||
| title: Single Sign On | |||
There was a problem hiding this comment.
Improvement — the two pages added here still name their own features three different ways.
- This page:
Single Sign Onin the title, headings and body. magic_link.md:7links here as "[single sign-on]", andautomated_user_provisioning.md:16links here as "[single sign-on]" too — so both inbound links are labelled differently from the page they land on.magic_link.mdis split against itself:Magic Linkin the title and line 7,magic linkin both##headings and lines 11/17.
CLAUDE.md asks for sentence case in headings, and every sibling in this group uses an unquoted sentence-case title (api_authentication_methods.md, service_accounts.md:2, api_key_rotation.md). "Single sign-on" is also the conventional rendering.
| title: Single Sign On | |
| title: Single sign-on |
If you go with this, the ## Enabling Single Sign On heading (line 9) and line 7 need the same treatment, as does Magic Link → Magic link on the magic link page — pick one form per feature and use it in the title, headings, prose and link text.
|
|
||
| ## Using magic link | ||
|
|
||
| <Steps> |
There was a problem hiding this comment.
Suggestion — the <Step> elements have no title, unlike every other <Steps> block in administration/. single_sign_on.md:20-44 in this same PR titles all four of its steps, and service_accounts.md:15-28 titles all four of its. Without titles these render as bare numbers, so a reader scanning the page gets no summary of the flow.
| <Steps> | |
| <Steps> | |
| <Step> |
The other two would be something like title="Check your inbox" and title="Click the link".
State on both pages that a SCIM-provisioned user's roles cannot be changed in Kosli, replacing the override-on-sync wording. Give the group-mapping steps their own heading with the screenshot inline, and move the callouts clear of both procedures. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
| <Frame><img src="/images/administration/magic-link-enter-email.png" alt="Kosli sign-in page with an email address entered and the Continue with SSO button" /></Frame> | ||
| </Step> | ||
| <Step> | ||
| Kosli then sends you an email containing the link and ask you to check your inbox |
There was a problem hiding this comment.
Improvement — subject–verb disagreement, and the sentence has no full stop. "Kosli then sends you an email … and ask you to check your inbox" should be "asks". This is the only one of the three <Step> bodies that doesn't terminate.
| Kosli then sends you an email containing the link and ask you to check your inbox | |
| Kosli then sends you an email containing the link and asks you to check your inbox. |
| icon: "wand-magic-sparkles" | ||
| --- | ||
|
|
||
| Magic Link is a way of signing into Kosli without needing to setup [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. |
There was a problem hiding this comment.
Improvement — "setup" is the noun; the verb is "set up".
| Magic Link is a way of signing into Kosli without needing to setup [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. | |
| Magic Link is a way of signing into Kosli without needing to set up [single sign-on](/administration/authentication/single_sign_on). When you want to sign in, Kosli emails you a link, and clicking that link signs you in. |
| title: Single Sign On | ||
| description: "Learn about configuring Single Sign On with Kosli" | ||
| icon: "key" | ||
| --- | ||
|
|
||
| Kosli supports signing-in using your identity provider, via Single Sign On (SSO). | ||
|
|
||
| ## Enabling Single Sign On |
There was a problem hiding this comment.
Improvement — the headings here are Title Case, and the two new pages name their own features inconsistently.
CLAUDE.md asks for sentence case for all headings; every sibling in this group uses an unquoted sentence-case title (api_authentication_methods.md:2 "API authentication methods", service_accounts.md:2 "Service accounts", api_key_rotation.md:2 "API key rotation"). Here the title, ## Enabling Single Sign On, and the body all use "Single Sign On".
The inconsistency is also visible to a reader following links:
magic_link.md:7andautomated_user_provisioning.md:16both link here with the text "single sign-on", so the link label never matches the page they land on.magic_link.mdis split against itself:Magic Linkin the title and lines 7/17,magic linkin both##headings and line 11.
Pick one rendering per feature and use it in the title, headings, prose and inbound link text.
| title: Single Sign On | |
| description: "Learn about configuring Single Sign On with Kosli" | |
| icon: "key" | |
| --- | |
| Kosli supports signing-in using your identity provider, via Single Sign On (SSO). | |
| ## Enabling Single Sign On | |
| title: Single sign-on | |
| description: "Learn about configuring single sign-on with Kosli." | |
| icon: "key" | |
| --- | |
| Kosli supports signing in using your identity provider, via single sign-on (SSO). | |
| ## Enabling single sign-on |
|
|
||
| ## Using magic link | ||
|
|
||
| <Steps> |
There was a problem hiding this comment.
Suggestion — these <Step> elements have no title, unlike every other <Steps> block in administration/. single_sign_on.md:20-44 in this same PR titles all four of its steps, and service_accounts.md:15-28 titles all four of its. Untitled steps render as bare numbers, so a reader scanning the page gets no summary of the flow — and the two pages added together are inconsistent with each other.
| <Steps> | |
| <Steps> | |
| <Step> |
The other two would be something like title="Check your inbox" and title="Click the link".
A review of the new SSO, Magic Link, and SCIM provisioning pages found the product names written inconsistently, several grammar slips, and no way to reach the human sign-in pages other than the left-hand navigation. Settle on "Single sign-on" (sentence case, hyphenated) and "Magic Link" as the product name, matching the spelling already used in the changelog, and apply them to titles, headings, body text, and image alt text. Fix the grammar slips found in the same pass: "setup" as a verb, a subject-verb disagreement, a missing period, "signing-in", a page referring to itself as a section, users rather than their access being revoked, and a time-relative "now" that would age badly. Add the reciprocal link from the single sign-on page to Magic Link, and link both from getting_started/authenticating_to_kosli, whose "Sign in to Kosli" step and "See also" list previously mentioned neither. The single sign-on page describes Magic Link only as an alternative for organizations without an identity provider; whether enabling SSO for a domain disables Magic Link is not yet confirmed, so it is left unstated.
The SCIM page claimed no SSO changes were needed, which is false for Okta over OIDC. Both pages now state one rule with its cause: Okta's SCIM integration only works over SAML, so an Okta OIDC connection has to be recreated.
The page never said SSO must be configured first, and buried org enablement under the roles section. Both are now listed up front, along with the wizard link and the IdP permissions needed, and the Setup paragraph is trimmed to stop repeating them.
Enabling SCIM changes nothing in Kosli; only later IdP changes do. Saying so resolves the apparent conflict between existing users keeping access and the IdP being authoritative, and adds a warning that a full or forced sync provisions every assigned user at once.
Setup and group mapping were prose, so the switch from the SCIM wizard to the SSO wizard was easy to miss. Both are now Steps blocks, with that switch as its own titled step and saving on the Testing page as a visible final step.
| [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"> |
There was a problem hiding this comment.
Improvement — the Setup sequence ends by triggering a sync, but the mapping that makes the sync produce correct roles isn't a step in it.
### Map your IdP groups to Kosli roles (line 88) is a required, three-step procedure in a different wizard, and it sits 26 lines below this block under a section titled "Roles for new and existing users" — which reads as conceptual, not procedural. Step 3 links there for "how to map those groups to Kosli roles", but a reader working this <Steps> block top-to-bottom reaches "Trigger a provisioning cycle" without having saved any mapping.
That matters more here than in most procedures, because the page itself says the first sync is not reversible in the app: it "provisions every assigned user at once" (line 76) and afterwards "their roles can no longer be changed in Kosli" (line 108).
Either pull the group-mapping steps into this sequence before the trigger step, or make the dependency explicit here:
| <Step title="Trigger a provisioning cycle"> | |
| <Step> | |
| Before triggering a sync, map each IdP group to its Kosli role — see | |
| [Map your IdP groups to Kosli roles](#map-your-idp-groups-to-kosli-roles). Users provisioned before the | |
| mapping is saved will not get the roles you intend. | |
| </Step> | |
| <Step> |
| ## Assigning roles | ||
|
|
||
| <Note> | ||
| This procedure does not apply to users provisioned through [automated user provisioning](/administration/managing_users/automated_user_provisioning) — their roles cannot be changed in Kosli. Manage those roles through your identity provider groups instead. |
There was a problem hiding this comment.
Improvement — on this page, "users" is defined to include service accounts, which makes this note say something you don't mean.
roles_in_kosli.md:8 sets a page-wide convention: "Wherever this page mentions a 'user', read it as 'user or service account' unless explicitly stated otherwise." Read under that rule, this note tells an admin that service-account roles also can't be changed in Kosli once SCIM is on — and service accounts are never SCIM-provisioned, so the dropdown procedure below still applies to them in full.
For an admin who has just enabled SCIM and needs to change a CI service account's role, that's the difference between doing it in one minute and opening a support ticket. Say "people" explicitly, since the note is user-only:
| This procedure does not apply to users provisioned through [automated user provisioning](/administration/managing_users/automated_user_provisioning) — their roles cannot be changed in Kosli. Manage those roles through your identity provider groups instead. | |
| <Note> | |
| This procedure does not apply to people provisioned through [automated user provisioning](/administration/managing_users/automated_user_provisioning) — their roles cannot be changed in Kosli, so manage them through your identity provider groups instead. Service accounts are never provisioned this way, so their roles are always changed here. | |
| </Note> |
| ## Roles for new and existing users | ||
|
|
||
| Kosli supports role assignment through your IdP, so that users' [roles within Kosli](/administration/managing_users/roles_in_kosli) can be managed by your onboarding and IT teams, without requiring admin access to Kosli. | ||
|
|
||
| You will need to tell us which of your Kosli organizations you wish to have SCIM enabled for; we will then create the necessary roles within our auth provider. Each organization will have four roles, with the names `kosli-<org-name>-<role>`, to correspond to the available roles in Kosli (admin, member, snapshotter, reader). | ||
|
|
||
| Within your IdP you will need to create a group for each of these roles. You will then add your users to the groups corresponding to the organizations/roles you wish them to have in Kosli. If a member receives two different roles for the same organization, the highest-privilege role will be assigned. |
There was a problem hiding this comment.
Suggestion — this section restates two things the reader has already been given, and names the auth provider two different ways.
- Line 84 "tell us which of your Kosli organizations you wish to have SCIM enabled for" is the same instruction as the prerequisite at lines 20-22 — and that prerequisite links here for the detail, so the reader follows a pointer and lands on the same sentence they came from.
- Line 86 "create a group for each of these roles… add your users to the groups" is the same instruction as Setup step 3 (lines 53-57), which also links here.
- Line 30 says "Kosli's auth provider"; line 84 says "our auth provider" for the same thing. The rest of these pages use "Kosli" rather than first person (
single_sign_on.md:45"your Kosli Customer Success representative").
Keeping only the naming scheme and the precedence rule here — the two facts that appear nowhere else — removes the round trip:
| ## Roles for new and existing users | |
| Kosli supports role assignment through your IdP, so that users' [roles within Kosli](/administration/managing_users/roles_in_kosli) can be managed by your onboarding and IT teams, without requiring admin access to Kosli. | |
| You will need to tell us which of your Kosli organizations you wish to have SCIM enabled for; we will then create the necessary roles within our auth provider. Each organization will have four roles, with the names `kosli-<org-name>-<role>`, to correspond to the available roles in Kosli (admin, member, snapshotter, reader). | |
| Within your IdP you will need to create a group for each of these roles. You will then add your users to the groups corresponding to the organizations/roles you wish them to have in Kosli. If a member receives two different roles for the same organization, the highest-privilege role will be assigned. | |
| ## Roles for new and existing users | |
| Kosli supports role assignment through your IdP, so that users' [roles within Kosli](/administration/managing_users/roles_in_kosli) can be managed by your onboarding and IT teams, without requiring admin access to Kosli. | |
| Kosli creates four roles per organization in its auth provider, named `kosli-<org-name>-<role>` — one for each Kosli role (admin, member, snapshotter, reader). Create a group in your IdP for each one you need. | |
| If a user ends up with two different roles for the same organization, the highest-privilege role wins. |
| "administration/authentication/api_authentication_methods", | ||
| "administration/authentication/service_accounts", | ||
| "administration/authentication/api_key_rotation" | ||
| "administration/authentication/api_key_rotation", | ||
| "administration/authentication/single_sign_on", | ||
| "administration/authentication/magic_link" | ||
| ] | ||
| }, | ||
| { | ||
| "group": "Users & roles", | ||
| "pages": [ | ||
| "administration/managing_users/roles_in_kosli", | ||
| "administration/managing_users/mapping_users_to_roles" | ||
| "administration/managing_users/mapping_users_to_roles", | ||
| "administration/managing_users/automated_user_provisioning" | ||
| ] | ||
| }, |
There was a problem hiding this comment.
Suggestion — the SSO/SCIM procedure is split across two groups, and the human sign-in pages are last in a group that now opens with machine credentials.
All three pages are correctly listed (core rule 2 satisfied), but the grouping splits one job across two sidebar groups. automated_user_provisioning.md requires an SSO connection as a prerequisite (line 18), and its group-mapping steps are performed in the SSO Configuration wizard (line 91) — so an admin doing SCIM works in Users & roles and Authentication & access alternately. Its Diátaxis form is also a how-to about IdP configuration, like single_sign_on.md, not role reference like its two current siblings.
Leading with human sign-in also matters now that there are five entries: an admin arriving at "Authentication & access" meets three API-credential pages before the two pages about how people log in.
| "administration/authentication/api_authentication_methods", | |
| "administration/authentication/service_accounts", | |
| "administration/authentication/api_key_rotation" | |
| "administration/authentication/api_key_rotation", | |
| "administration/authentication/single_sign_on", | |
| "administration/authentication/magic_link" | |
| ] | |
| }, | |
| { | |
| "group": "Users & roles", | |
| "pages": [ | |
| "administration/managing_users/roles_in_kosli", | |
| "administration/managing_users/mapping_users_to_roles" | |
| "administration/managing_users/mapping_users_to_roles", | |
| "administration/managing_users/automated_user_provisioning" | |
| ] | |
| }, | |
| "pages": [ | |
| "administration/authentication/single_sign_on", | |
| "administration/authentication/magic_link", | |
| "administration/managing_users/automated_user_provisioning", | |
| "administration/authentication/api_authentication_methods", | |
| "administration/authentication/service_accounts", | |
| "administration/authentication/api_key_rotation" | |
| ] | |
| }, | |
| { | |
| "group": "Users & roles", | |
| "pages": [ | |
| "administration/managing_users/roles_in_kosli", | |
| "administration/managing_users/mapping_users_to_roles" | |
| ] | |
| }, |
Non-blocking, and the file path can stay under managing_users/ either way — but if you'd rather not move it, at least the two sign-in pages are worth promoting above the API pages.
|
Closing to open again with a cleaner set of comments |
Adds three placeholder pages for content to be written manually:
administration/authentication/single_sign_on.md— "Single Sign On", under Authentication & accessadministration/authentication/magic_link.md— "Magic Link", under Authentication & accessadministration/managing_users/automated_user_provisioning.md— "Automated User Provisioning", under Users & rolesEach page contains only its title. Extracted from #380 so this authentication work can proceed independently of the Kosli Capture page.
Generated by Mintlify Agent.
Requested by: graham@kosli.com via Slack
Mintlify session: slack_1782915660.508229_D0AM66349C1