Introduces IAuthorizationHeaderProviderExtension #129
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
jennyf19
reviewed
Jun 17, 2024
src/Microsoft.Identity.Abstractions/DownstreamApi/IAuthorizationHeaderProviderExtension.cs
Outdated
Show resolved
Hide resolved
jennyf19
reviewed
Jun 17, 2024
src/Microsoft.Identity.Abstractions/ApplicationOptions/RequestContext.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Identity.Abstractions/DownstreamApi/IAuthorizationHeaderProviderExtension.cs
Outdated
Show resolved
Hide resolved
src/Microsoft.Identity.Abstractions/DownstreamApi/IAuthorizationHeaderProviderExtension.cs
Outdated
Show resolved
Hide resolved
sruke
force-pushed
the
sruthi/HeaderProviderExtension
branch
from
6f84321 to
762e446
Compare
src/Microsoft.Identity.Abstractions/DownstreamApi/IAuthorizationHeaderProvider.cs
Show resolved
Hide resolved
sruke
force-pushed
the
sruthi/HeaderProviderExtension
branch
from
b425ad5 to
2c7fd8e
Compare
| /// <param name="cancellationToken">A token to cancel the operation.</param> | ||
| /// <returns>A string containing the authorization header, such as "Bearer token" or "PoP token".</returns> | ||
| Task<string> CreateAuthorizationHeaderAsync( | ||
| IEnumerable<string> scopes, |
There was a problem hiding this comment.
Do we have to pass IEnumerable can it be IList?
There was a problem hiding this comment.
IEnumerable is consistent with the CreateAuthorizationHeaderForUserAsync signature. However, sometimes we manipulate the scopes (like adding default ones), in that case IList would be better. I prefer the IList, unless you'd prefer IEnumerable for consistency.
There was a problem hiding this comment.
It's supposed to be immutable. No need to manipulate anything. IEnumerable is the base interface for string[], IList etc ...
pmaytak
reviewed
Jun 20, 2024
src/Microsoft.Identity.Abstractions/DownstreamApi/IAuthorizationHeaderProvider.cs
Show resolved
Hide resolved
pmaytak
reviewed
Jun 20, 2024
src/Microsoft.Identity.Abstractions/DownstreamApi/IAuthorizationHeaderProvider.cs
Show resolved
Hide resolved
jmprieur
approved these changes
Jun 20, 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.
What?
This PR updates the IAuthorizationHeaderProvider interface to include the CreateAuthorizationHeaderAsync API. This new API allows for acquiring an authorization header on behalf of either a user or an application. This is a breaking change. To accomodate it Microsoft.Identity.Abstractions will update its major version.
Why?
The current interface exposes separate APIs for obtaining headers on behalf of a user and an app.
The existing method for acquiring a header on behalf of an app does not accept a ClaimsPrincipal, limiting the flexibility and usability of the current API.