Added ability to use Issuer to receive Token Endpoint for the OAuth2ClientBuilder #1656
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.
Proposed Changes
Added an optional overload to the constructor of the OAuth2ClientBuilder to provide an Issuer instead of the Token Endpoint. When the OAuth2Client is build (using
Build()
orBuildAsync()
) and no Token Endpoint is provided, the Token Endpoint will be fetched from the discovery page of the Issuer (must support OpenID Connect).In addition I added some documentation for most of the methods in OAuth2Client, IOAuth2Client and OAuth2ClientBuilder.
Initial request and discussion was started here: #1653
Types of Changes
What types of changes does your code introduce to this project?
Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creatingthe PR. If you're unsure about any of them, don't hesitate to ask on the
mailing list. We're here to help! This is simply a reminder of what we are
going to look for before merging your code.
CONTRIBUTING.md
documentFurther Comments
The retrieval of the Token Endpoint is Async, when building the client with the synchronous method (
Build()
) the request is blocked until the Endpoint is received. Because of backwards compatibility I can't refactor it. I added an AsyncBuildAsync()
method which does this more correctly. When providing the Token Endpoint directly nothing will be done while building.Feel free to suggest some better methods.
My IDE suggested changes in PublicAPI.Shipped.txt and PublicAPI.Unshipped.txt. Please check if the changes in there are correct, because these files are new to me.