Skip to content

Commit 6eb9fda

Browse files
dorshaclaude
andcommitted
docs(xaa): XAA trust is read via the dedicated Load XAA settings API
Update the XAAIssuerSettings/XAAJWTBearerSettings docstrings + README to drop the "returned by the tenant get-settings API" claim - XAA is no longer surfaced on tenant load; read it via load_xaa_settings / load_all_xaa_settings. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 5df03c9 commit 6eb9fda

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1811,7 +1811,7 @@ descope_client.mgmt.third_party_application.delete_batch([app_id])
18111811

18121812
### Manage Cross-App Access (XAA / ID-JAG)
18131813

1814-
Cross-App Access (XAA), built on the OAuth identity-assertion authorization grant (ID-JAG), lets a tenant trust external OIDC issuers so a token minted by a trusted issuer can be exchanged for a Descope token (the RFC 7523 `jwt-bearer` grant). XAA trust is configured **per SSO configuration** of a tenant through the SSO management API, addressed by its `sso_id` (omit it, or pass an empty string, for the tenant's default SSO configuration). The trusted issuers are set together with the config-level shared group/role mapping. The exported `XAASettings`, `XAAJWTBearerSettings`, and `XAAIssuerSettings` classes describe the write payload; the same issuer shape is returned under a tenant's `idJagSettings` by the tenant get-settings API.
1814+
Cross-App Access (XAA), built on the OAuth identity-assertion authorization grant (ID-JAG), lets a tenant trust external OIDC issuers so a token minted by a trusted issuer can be exchanged for a Descope token (the RFC 7523 `jwt-bearer` grant). XAA trust is configured **per SSO configuration** of a tenant through the SSO management API, addressed by its `sso_id` (omit it, or pass an empty string, for the tenant's default SSO configuration). The trusted issuers are set together with the config-level shared group/role mapping. The exported `XAASettings`, `XAAJWTBearerSettings`, and `XAAIssuerSettings` classes describe the write payload; the same shape is returned by the dedicated Load XAA settings API (`load_xaa_settings` / `load_all_xaa_settings`), not on tenant load.
18151815

18161816
```python
18171817
from descope import AttributeMapping, RoleMapping, XAAIssuerSettings, XAAJWTBearerSettings, XAASettings

descope/management/sso_settings.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ class XAAIssuerSettings:
5959
"""
6060
Cross-App Access (XAA / ID-JAG) trusted-issuer settings, including per-issuer JIT provisioning and
6161
user attribute mapping (parity with the SSO login JIT). Group-to-role mapping reuses the tenant's
62-
shared SSO group mapping. Describes the shape of each entry under a tenant's ``idJagSettings.issuers``
63-
map, as returned by the tenant get-settings API.
62+
shared SSO group mapping. Describes the shape of each entry under the trust config's ``issuers`` map,
63+
as returned by the dedicated Load XAA settings API (``load_xaa_settings`` / ``load_all_xaa_settings``).
6464
"""
6565

6666
def __init__(
@@ -83,8 +83,9 @@ def __init__(
8383
class XAAJWTBearerSettings:
8484
"""
8585
A tenant's Cross-App Access (XAA / ID-JAG) trust config: the set of trusted issuers keyed by issuer
86-
URL, plus the jwt-bearer grant configuration. Returned as ``idJagSettings`` by the tenant
87-
get-settings API and used as the ``settings`` field of the XAA configure request.
86+
URL, plus the jwt-bearer grant configuration. Used as the ``settings`` field of the XAA configure
87+
request, and returned under ``settings`` by the dedicated Load XAA settings API
88+
(``load_xaa_settings`` / ``load_all_xaa_settings``).
8889
"""
8990

9091
def __init__(

0 commit comments

Comments
 (0)