Add response subtypes for different oauth2 grants #1051
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The initial goal of this work is to allow a function handling a token
response, e.g., in a tokenstorage interface, to determine the context
in which the original call was made. It is now possible to check
if isinstance(response, RefreshTokenResponse): ...
in a generic token handler.
Additionally, this opens the way for distinct token response objects
to implement methods which vary based on the known properties of their
respective grant types. For example, RefreshTokenResponse could
raise a more informative error when `decode_id_token` is called and
no `id_token` is present.
sirosen
requested review from
aaschaer,
ada-globus,
derek-globus and
kurtmckee
as code owners
kurtmckee
requested changes
Sep 17, 2024
Co-authored-by: Kurt McKee <contactme@kurtmckee.org>
Co-authored-by: Kurt McKee <contactme@kurtmckee.org>
Co-authored-by: Kurt McKee <contactme@kurtmckee.org>
derek-globus
requested changes
Sep 17, 2024
Per discussion, this is a slight rename to restore the `OAuth` prefix and reduce the suffix to `Response`.
kurtmckee
approved these changes
Sep 17, 2024
derek-globus
approved these changes
Sep 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The initial goal of this work is to allow a function handling a token
response, e.g., in a tokenstorage interface, to determine the context
in which the original call was made. It is now possible to check
in a generic token handler.
Additionally, this opens the way for distinct token response objects
to implement methods which vary based on the known properties of their
respective grant types. For example, OAuthRefreshTokenResponse could
raise a more informative error when
decode_id_tokenis called andno
id_tokenis present.📚 Documentation preview 📚: https://globus-sdk-python--1051.org.readthedocs.build/en/1051/