Commit 2171567
docs: update User Sources for configurable scopes + Advanced section (#990)
* docs: update User Sources for configurable scopes + Advanced section (GRO-166)
Follow-up to monorepo #1448 (GRO-165). Coordinator now exposes a
configurable `scopes` field on User Sources (default
`["openid", "profile", "email"]`, openid required, validated against
the IdP's `scopes_supported`); the Dashboard puts both `scopes` and
`subject_claim` into an Advanced collapsible section since the
defaults cover most setups.
User Sources overview:
- Move Subject Claim out of the primary "Fill in the User Source
details" bullet list. Add a one-line pointer to the Advanced section.
- Replace "Pick a subject claim" with "Advanced: scopes and subject
claim", split into two subsections. Scopes subsection notes the
openid requirement and scopes_supported validation; subject claim
subsection keeps the stability + uniqueness guidance and adds the
directory-wide-identifier note for providers that expose one (Entra
`oid` as the canonical example).
Microsoft Entra ID page:
- Rename "Allow the openid permission" -> "Grant the OIDC permissions".
Admins now grant openid, profile, AND email. The `profile` grant is
what unlocks `oid` later for teams that want it.
- Add a TODO note for the API-permissions screenshot — needs all three
scopes checked, currently only openid.
- Drop the Subject Claim row from "Copy these values to Arcade".
Replace with a pointer to the new Advanced settings section.
- Add an "Advanced settings" section that frames `sub` as the default
with `oid` as the opt-in for cross-app correlation, calling out the
privacy trade-off and the `profile` scope dependency.
- Update the Custom subject claims Note to reference the new overview
anchor and drop the `oid` prescription.
Okta page:
- Drop the Subject Claim row from "Copy these values to Arcade" the
same way; replace with a pointer to Advanced settings.
- Add an Advanced settings section noting `sub` default + Custom
Authorization Server caveat for both fields.
- Update the Custom subject claims Note to reference the new anchor.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: tighten provider-page coverage of the Advanced section
Per Wils — say less about the Advanced section in the per-provider
pages. The overview already covers it; the only provider page where
the Advanced section is worth a callout is Entra (oid for auditing).
Okta:
- Drop the standalone "Advanced settings" section entirely. The table
trailer now points readers to the overview's Advanced section if
they want to customize.
Microsoft Entra ID:
- Replace the broad "Advanced settings" subsection with a focused
"Optional: use oid as the subject claim" subsection that frames the
switch as an auditing/correlation choice rather than a generic
Advanced overview.
- Update the table trailer to point at the new section anchor.
- Trim the Custom subject claims Note since oid now has its own
section heading.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: refresh Entra API permissions screenshot for all three scopes
Replace the old screenshot (only openid checked) with the new one
showing openid, profile, and email all checked — matches the new
default scope set the docs now instruct admins to grant. Remove the
TODO comment.
Same dimensions (1312 × 849) as the prior screenshot, so the page
layout is unchanged.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: tighten Entra oid section + fix broken anchor
- Rewrite the "Optional: use oid as the subject claim" paragraph to
match the rest of the page's tone — three short paragraphs (what
the default is, when to switch, the prerequisite) instead of one
long comma-stacked sentence.
- Fix a broken `#advanced-settings` anchor in the OIDC permissions
step. The Advanced settings section was replaced by the focused
"Optional: use oid as the subject claim" section in 06a6d80;
the link was missed in that cleanup. Re-point at the surviving
`#optional-use-oid-as-the-subject-claim` anchor.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: drop Advanced section call-out from Okta page
Per Wils — the Advanced section isn't worth surfacing on the Okta
page since `sub` is the right pick for almost every Okta setup and
the Org Authorization Server emits the default scopes without any
admin action.
- Remove the table trailer that pointed readers at the form's
Advanced section.
- Rewrite the Custom subject claims Note to lead with what Okta's
`sub` actually is (the user's Okta user ID), then route admins
who need a different value to the Custom Authorization Server
approach.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: cut the Advanced bridge paragraph from the User Sources overview
Per Wils — the bridge to the Advanced section was unnecessary noise
between the field list and the Save step. The Advanced section already
has its own H2 below; readers who want it will find it via the TOC.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent e08a2d8 commit 2171567
4 files changed
Lines changed: 31 additions & 12 deletions
File tree
- app/en/guides/user-sources
- microsoft-entra-id
- okta
- public/images/user-sources/microsoft-entra-id
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
79 | 79 | | |
80 | 80 | | |
81 | 81 | | |
82 | | - | |
| 82 | + | |
83 | 83 | | |
84 | 84 | | |
85 | 85 | | |
86 | | - | |
| 86 | + | |
87 | 87 | | |
88 | | - | |
| 88 | + | |
89 | 89 | | |
90 | 90 | | |
91 | | - | |
| 91 | + | |
92 | 92 | | |
93 | 93 | | |
94 | 94 | | |
| |||
106 | 106 | | |
107 | 107 | | |
108 | 108 | | |
109 | | - | |
| 109 | + | |
| 110 | + | |
110 | 111 | | |
111 | 112 | | |
112 | 113 | | |
113 | 114 | | |
114 | 115 | | |
115 | 116 | | |
116 | 117 | | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
117 | 126 | | |
118 | 127 | | |
119 | 128 | | |
120 | 129 | | |
121 | 130 | | |
122 | | - | |
| 131 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
93 | 93 | | |
94 | 94 | | |
95 | 95 | | |
96 | | - | |
97 | 96 | | |
98 | 97 | | |
99 | 98 | | |
| |||
106 | 105 | | |
107 | 106 | | |
108 | 107 | | |
109 | | - | |
| 108 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
64 | 64 | | |
65 | 65 | | |
66 | 66 | | |
67 | | - | |
68 | 67 | | |
69 | 68 | | |
70 | 69 | | |
71 | 70 | | |
72 | 71 | | |
73 | 72 | | |
74 | 73 | | |
75 | | - | |
| 74 | + | |
76 | 75 | | |
77 | | - | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
78 | 89 | | |
79 | 90 | | |
80 | 91 | | |
81 | 92 | | |
82 | | - | |
| 93 | + | |
83 | 94 | | |
84 | 95 | | |
85 | 96 | | |
| |||
0 commit comments