docs(hub): document Okta and Entra ID group directories - #1236
Merged
Conversation
Adds a shared "Group directories" section to the Identity overview covering spec.directory, the four supported config kinds, and the naming rule that makes directory groups usable as role-binding subjects. Adds directory configuration to the Okta page (API Services app, private_key_jwt, JWKS key, okta.groups.read/okta.users.read scopes, optional DPoP) and restructures the Entra page to the same shape. Also repoints an Entra anchor link in the access control troubleshooting page that the restructure would otherwise have broken.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Builds on this branch to document
spec.directoryonIdentityProvider— the block that lets Hub query an IdP for groups and users so admins can search for a group when writing a role binding instead of decoding a token to find its name.What's here
features/identity/overview.md— new "Group directories" section. Covers thedirectoryblock, the four supported config kinds, the group/user query endpoints, and the caching and credential-redaction behavior. The subsection that matters most is Matching directory groups to role bindings: a directory group is named<idp-name>:<claim value>while a signed-in user's groups are<userInfoPrefix><claim value>, so bindings only apply whenuserInfoPrefixandgroupClaimTypeare chosen to make those agree. Entra wantsDirectoryID, Okta wantsDisplayName.features/identity/okta.md— all new directory content. Okta needs a second app (API Services) authenticating with a signed JWT assertion, since it won't mint Management API tokens for a client secret. Documents the key pair, theokta.groups.read/okta.users.readscopes, optional DPoP, theOktaConfigurationfields, and troubleshooting.features/identity/entra-id.md— restructured to the same section order as Okta so the two read as a matched pair. Adds the claim-type guidance and search/caching behavior; tightens the group-overage explanation.features/access-control/troubleshooting.md— one-line anchor fix. It linked to an Entra heading the restructure removed.Reviewing
The Entra page was reordered, so the diff looks larger than the change actually is. Technical content is unchanged apart from the claim-type section and the search-behavior notes.
npm run buildpasses. Note it only passes with thefeatures/identity/auth0andfeatures/identity/dexsidebar entries removed — those docs don't exist yet on this branch, andoverview.mdlinks them too. Pre-existing, left alone for you to resolve.