Skip to content
This repository was archived by the owner on Jun 23, 2023. It is now read-only.

Commit ed7e849

Browse files
committed
Add README
1 parent 47120f8 commit ed7e849

1 file changed

Lines changed: 40 additions & 0 deletions

File tree

docs/source/contents/conf.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -759,4 +759,44 @@ clients scopes_to_claims).
759759
-----------------------
760760
revoke_refresh_on_issue
761761
-----------------------
762+
762763
Configure whether to revoke the refresh token that was used to issue a new refresh token
764+
765+
----------
766+
add_claims
767+
----------
768+
769+
A dictionary with the following keys
770+
771+
always
772+
######
773+
774+
A dictionary with the following keys: `userinfo`, `id_token`, `introspection`, `access_token`.
775+
The keys are used to describe the claims we want to add to the corresponding interface.
776+
The keys can be a list of claims to be added or a dict in the format described
777+
in https://openid.net/specs/openid-connect-core-1_0.html#IndividualClaimsRequests
778+
E.g.::
779+
780+
{
781+
"add_claims": {
782+
"always": {
783+
"userinfo": ["email", "phone"], # Always add "email" and "phone" in the userinfo response if such claims exists
784+
"id_token": {"email": null}, # Always add "email" in the id_token if such a claim exists
785+
"introspection": {"email": {"value": "a@a.com"}}, # Add "email" in the introspection response only if its value is "a@a.com"
786+
}
787+
}
788+
}
789+
790+
by_scope
791+
########
792+
793+
A dictionary with the following keys: `userinfo`, `id_token`, `introspection`, `access_token`.
794+
The keys are boolean values that describe whether the scopes should be mapped
795+
to claims and added to the response.
796+
E.g.::
797+
798+
{
799+
"add_claims": {
800+
"by_scope": {
801+
id_token: True, # Map the requested scopes to claims and add them to the id token
802+
}

0 commit comments

Comments
 (0)