docs(sso-setup): add user-consent fields to oauth2PermissionScopes#2821
Open
docs(sso-setup): add user-consent fields to oauth2PermissionScopes#2821
Conversation
The Step 3 and Step 4 `oauth2PermissionScopes` payloads were missing `userConsentDescription` and `userConsentDisplayName`. Without these, the consent prompt shown to end users falls back to the admin text or default strings when the scope is `type: "User"`. Also expand `adminConsentDescription` from "Access as user" to a sentence that actually describes what the scope grants. Picks up content from #2705 (which was opened against the pre-rewrite `sso-setup.md` and is now superseded by #2719's rename to .mdx). Refs: #2670, #2705 Co-authored-by: Hugo Gonzalez <hugogonzalez@microsoft.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the SSO setup documentation to ensure the access_as_user scope has end-user consent text configured, improving the consent prompt UX for user-scoped delegated permissions.
Changes:
- Add
userConsentDescriptionanduserConsentDisplayNameto theoauth2PermissionScopespayloads in Steps 3 and 4. - Expand
adminConsentDescriptionto a fuller descriptive sentence (instead of matching the display name).
corinagum
force-pushed
the
cg/sso-setup-user-consent
branch
from
909d85a to
7d2afbb
Compare
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
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.
Summary
The Step 3 and Step 4
oauth2PermissionScopespayloads insso-setup.mdxwere missing two fields:userConsentDescriptionuserConsentDisplayNameWhen the scope is
type: "User"(which it is here), these fields are what end users see at the consent prompt. Without them, the prompt falls back to the admin text or default strings — a degraded UX.This PR also expands
adminConsentDescriptionfrom"Access as user"(which was identical to the display name) to an actual descriptive sentence.Context
PR #2705 opened by @hggzm originally added these fields against the pre-rewrite
sso-setup.md. That file was renamed tosso-setup.mdxand substantially rewritten in #2719, leaving #2705 with an unresolvable rebase conflict (modify/delete). This PR re-applies the contribution against the current file. Closes the gap; #2705 can be closed as superseded.Refs: #2670, #2705