docs(xaa): document the read-only project-level audience on the XAA load response - #1677
docs(xaa): document the read-only project-level audience on the XAA load response#1677dorsha wants to merge 1 commit into
Conversation
…oad response load_xaa_settings / load_all_xaa_settings return the audience a requesting application must present in its ID-JAG token. It is project-level and names no tenant - the IdP sends the tenant in the token's aud_tenant claim - so document it as part of the returned shape rather than leaving callers to build the value by hand. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
🐕 Review complete — View session on Shuni Portal 🐾 |
🐕 Suggested ReviewersThis PR documents the read-only
Suggested by Shuni based on git history and PR context. Names are not @-mentioned to avoid notifying anyone — request a review from whoever fits best. |
There was a problem hiding this comment.
🐕 Shuni Review
Docs-only change: updates docstrings for load_xaa_settings (sync/async) to document the read-only, project-level audience field and adds a matching test assertion.
Actionable comments posted: 0
Merge risk: 🟢 Low: no functional code changed — response.json() already passes the audience field through untouched, and the docstring wording/test fixture are consistent between the sync and async variants.
Review scope: Full review
Reviewed files (3)
descope/management/sso_settings.pydescope/management/sso_settings_async.pytests/management/test_sso_settings.py
Coverage reportThe coverage rate went from None of the new lines are part of the tested code. Therefore, there is no coverage data about them. |
Related Issues
Required for:
https://github.com/descope/etc/issues/18013
Related PRs
Upstream PRs
Related PRs
In a Nutshell
audienceon the XAA load responseDescription
Loading Cross-App Access settings also returns the audience a requesting application has to present in its ID-JAG token, so the docstrings now say so instead of leaving callers to build the value themselves. It has no tenant in it - the identity provider sends the tenant in the token's
aud_tenantclaim.Must