Skip to content

docs(custom-claims): add documentation for custom claims class usage with ORCID example - #772

Open
MartinPaulEve wants to merge 3 commits into
authlib:mainfrom
MartinPaulEve:main
Open

docs(custom-claims): add documentation for custom claims class usage with ORCID example#772
MartinPaulEve wants to merge 3 commits into
authlib:mainfrom
MartinPaulEve:main

Conversation

@MartinPaulEve

Copy link
Copy Markdown

This PR creates documentation for using the new custom-claims feature, as per #725

DO NOT SEND ANY SECURITY FIX HERE. Please read "Security Reporting" section
on README.

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Other, please describe: docs

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

  • You consent that the copyright of your pull request source code belongs to Authlib's author.

Comment thread docs/client/orcid.rst
---------------------
Since Authlib 1.5.2 there is the functionality to pass a custom claims class to authorize_access_token.

To do so, create a custom claims class:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Doc syntax error, should be ending with ::

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

If you look at the "raw" version, it is:

"To do so, create a custom claims class::" ?

yfguo pushed a commit to yfguo/open-webui that referenced this pull request Nov 4, 2025
This is a known is of upstream authlib as mentioned
authlib/authlib#725. A upstream fix is pending at
authlib/authlib#772.
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.

2 participants