Skip to content

Commit 063a889

Browse files
committed
OpenID: Explain get_discovery_claims in docs
1 parent 57535b4 commit 063a889

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/oidc.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,12 @@ the claim data::
271271

272272
return claims
273273

274-
Standard claim ``sub`` is included by default, for remove it override ``get_claim_list``.
274+
Standard claim ``sub`` is included by default, for remove it override ``get_claim_dict``.
275+
276+
In some cases, it might be desirable to not list all claims in discovery info. To customize
277+
which claims are advertised, you can override the ``get_discovery_claims`` method to return
278+
a list of claim names to advertise. If your ``get_additional_claims`` uses the first form
279+
and you still want to advertise claims, you can also override ``get_discovery_claims``.
275280

276281
In order to help lcients discover claims early, they can be advertised in the discovery
277282
info, under the ``claims_supported`` key. In order for the discovery info view to automatically

0 commit comments

Comments
 (0)