Skip to content

docs(xaa): document the read-only project-level audience on the XAA load response - #1677

Open
dorsha wants to merge 1 commit into
mainfrom
feat/xaa-project-level-audience
Open

docs(xaa): document the read-only project-level audience on the XAA load response#1677
dorsha wants to merge 1 commit into
mainfrom
feat/xaa-project-level-audience

Conversation

@dorsha

@dorsha dorsha commented Aug 25, 2026

Copy link
Copy Markdown
Member

Related Issues

Required for:
https://github.com/descope/etc/issues/18013

Related PRs

Upstream PRs

Related PRs

In a Nutshell

  • Document the read-only audience on the XAA load response

Description

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_tenant claim.

Must

  • Tests
  • Documentation (if applicable)

…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>
@shuni-bot

shuni-bot Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

🐕 Review complete — View session on Shuni Portal 🐾

@shuni-bot

shuni-bot Bot commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

🐕 Suggested Reviewers

This PR documents the read-only audience field on XAA load response across both sync and async SSO settings implementations. The changes span 3 files with equal coverage of sync/async implementations and tests. LioriE has extensive experience with all affected files (4 commits across all 3 files), making them the primary reviewer. omercnet complements with solid coverage of the core SSO settings file and tests (2 commits). Together, they provide comprehensive expertise in both the implementation and test suite for this documentation update.

Reviewer Reason
LioriE LioriE has 4 commits across all 3 modified files (sso_settings.py, sso_settings_async.py, test_sso_settings.py), providing the deepest expertise in both sync/async implementations and related tests.
omercnet omercnet has 2 commits across the core sso_settings.py and test suite, offering complementary perspective on the main implementation and test coverage for this documentation change.

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.

@shuni-bot shuni-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🐕 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.py
  • descope/management/sso_settings_async.py
  • tests/management/test_sso_settings.py

@github-actions

Copy link
Copy Markdown

Coverage report

The coverage rate went from 98.26% to 98.26% ➡️

None of the new lines are part of the tested code. Therefore, there is no coverage data about them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant