Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ namespace TokenAcquisition {
}

class IAuthorizationHeaderProvider { <<interface>> }
class IAuthorizationHeaderBoundProvider { <<interface>> }
class IAuthorizationHeaderProvider1 { <<interface>> }
class IAuthorizationHeaderProvider_TResult_ { <<interface>> }
class IDownstreamApi { <<interface>>
+CallApiAsync(...)
Expand Down Expand Up @@ -423,7 +423,7 @@ It's also possible (and recommended) to use higher level APIs:
- IAuthorizationHeaderProvider is the component that provides the authorization header, delegating to the ITokenAcquirer.
Whereas ITokenAcquirer only knows about tokens, IAuthorizationHeaderProvider knows about protocols (for instance bearer,
Pop, etc ...)
- IAuthorizationHeaderBoundProvider extends IAuthorizationHeaderProvider to provide authorization headers along with
- IAuthorizationHeaderProvider1 extends IAuthorizationHeaderProvider to provide authorization headers along with
bound certificate information, useful for scenarios requiring certificate binding details.

```mermaid
Expand Down Expand Up @@ -461,7 +461,7 @@ It's also possible (and recommended) to use higher level APIs:
+Task&lt;string&gt; CreateAuthorizationHeaderForAppAsync(string scopes, AuthorizationHeaderProviderOptions downstreamApiOptions, CancellationToken cancellationToken)
+Task&lt;string&gt; CreateAuthorizationHeaderAsync(IEnumerable&lt;string&gt; scopes, AuthorizationHeaderProviderOptions options, ClaimsPrincipal claimsPrincipal, CancellationToken cancellationToken)
}
class IAuthorizationHeaderBoundProvider { <<interface>>
class IAuthorizationHeaderProvider1 { <<interface>>
+Task&lt;AuthorizationHeaderInformation&gt; CreateAuthorizationHeaderBoundForUserAsync(IEnumerable&lt;string&gt; scopes, AuthorizationHeaderProviderOptions authorizationHeaderProviderOptions, ClaimsPrincipal claimsPrincipal, CancellationToken cancellationToken)
+Task&lt;AuthorizationHeaderInformation&gt; CreateAuthorizationHeaderBoundForAppAsync(string scopes, AuthorizationHeaderProviderOptions downstreamApiOptions, CancellationToken cancellationToken)
+Task&lt;AuthorizationHeaderInformation&gt; CreateAuthorizationHeaderBoundAsync(IEnumerable&lt;string&gt; scopes, AuthorizationHeaderProviderOptions options, ClaimsPrincipal claimsPrincipal, CancellationToken cancellationToken)
Expand Down Expand Up @@ -523,13 +523,13 @@ It's also possible (and recommended) to use higher level APIs:

AuthorizationHeaderProviderOptions <|-- DownstreamApiOptions : Inherits
DownstreamApiOptions <|-- DownstreamApiOptionsReadOnlyHttpMethod : Inherits
IAuthorizationHeaderProvider <|-- IAuthorizationHeaderBoundProvider : Inherits
IAuthorizationHeaderProvider <|-- IAuthorizationHeaderProvider1 : Inherits
CredentialDescription --> "DecryptKeysAuthenticationOptions" AuthorizationHeaderProviderOptions : Has
AuthorizationHeaderProviderOptions --> "AcquireTokenOptions" AcquireTokenOptions : Has
AcquireTokenOptions --> "ManagedIdentity" ManagedIdentityOptions : Has
IDownstreamApi ..> DownstreamApiOptions : Uses
IAuthorizationHeaderProvider ..> AuthorizationHeaderProviderOptions : Uses
IAuthorizationHeaderBoundProvider ..> AuthorizationHeaderProviderOptions : Uses
IAuthorizationHeaderProvider1 ..> AuthorizationHeaderProviderOptions : Uses

```

Expand Down
2 changes: 1 addition & 1 deletion agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Through its well-designed abstractions and interfaces, Microsoft.Identity.Abstra
- ITokenAcquirer - Core interface for token acquisition
- ITokenAcquirerFactory - Factory of Token acquirers
- IAuthorizationHeaderProvider - creates authorization headers (getting tokens and building the protocol string)
- IAuthorizationHeaderBoundProvider - extends IAuthorizationHeaderProvider to provide authorization headers with bound certificate information
- IAuthorizationHeaderProvider1 - extends IAuthorizationHeaderProvider to provide authorization headers with bound certificate information
- IDownstreamApi - call downstream APIs in an authenticated way.

### Development Guidelines
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace Microsoft.Identity.Abstractions
/// Creates an authorization header value that the caller can use to access a protected web API, which supports either unbound or
/// bound to a certificate (for example, in an mTLS PoP scenario) tokens.
/// </summary>
public interface IAuthorizationHeaderBoundProvider : IAuthorizationHeaderProvider<OperationResult<AuthorizationHeaderInformation, AuthorizationHeaderError>>
public interface IAuthorizationHeaderProvider1 : IAuthorizationHeaderProvider<OperationResult<AuthorizationHeaderInformation, AuthorizationHeaderError>>
{
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#nullable enable
Microsoft.Identity.Abstractions.IAuthorizationHeaderBoundProvider
Microsoft.Identity.Abstractions.IAuthorizationHeaderBoundProvider.CreateAuthorizationHeaderBoundAsync(System.Collections.Generic.IEnumerable<string!>! scopes, Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions? options = null, System.Security.Claims.ClaimsPrincipal? claimsPrincipal = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Microsoft.Identity.Abstractions.AuthorizationHeaderInformation!>!
Microsoft.Identity.Abstractions.IAuthorizationHeaderBoundProvider.CreateAuthorizationHeaderBoundForAppAsync(string! scopes, Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions? downstreamApiOptions = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Microsoft.Identity.Abstractions.AuthorizationHeaderInformation!>!
Microsoft.Identity.Abstractions.IAuthorizationHeaderBoundProvider.CreateAuthorizationHeaderBoundForUserAsync(System.Collections.Generic.IEnumerable<string!>! scopes, Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions? authorizationHeaderProviderOptions = null, System.Security.Claims.ClaimsPrincipal? claimsPrincipal = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Microsoft.Identity.Abstractions.AuthorizationHeaderInformation!>!
Microsoft.Identity.Abstractions.IAuthorizationHeaderProvider1
Microsoft.Identity.Abstractions.IAuthorizationHeaderProvider1.CreateAuthorizationHeaderBoundAsync(System.Collections.Generic.IEnumerable<string!>! scopes, Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions? options = null, System.Security.Claims.ClaimsPrincipal? claimsPrincipal = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Microsoft.Identity.Abstractions.AuthorizationHeaderInformation!>!
Microsoft.Identity.Abstractions.IAuthorizationHeaderProvider1.CreateAuthorizationHeaderBoundForAppAsync(string! scopes, Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions? downstreamApiOptions = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Microsoft.Identity.Abstractions.AuthorizationHeaderInformation!>!
Microsoft.Identity.Abstractions.IAuthorizationHeaderProvider1.CreateAuthorizationHeaderBoundForUserAsync(System.Collections.Generic.IEnumerable<string!>! scopes, Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions? authorizationHeaderProviderOptions = null, System.Security.Claims.ClaimsPrincipal? claimsPrincipal = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<Microsoft.Identity.Abstractions.AuthorizationHeaderInformation!>!
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
#nullable enable
Microsoft.Identity.Abstractions.IAuthorizationHeaderBoundProvider
Microsoft.Identity.Abstractions.IAuthorizationHeaderProvider1
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
#nullable enable
Microsoft.Identity.Abstractions.IAuthorizationHeaderBoundProvider
Microsoft.Identity.Abstractions.IAuthorizationHeaderProvider1
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
#nullable enable
Microsoft.Identity.Abstractions.IAuthorizationHeaderBoundProvider
Microsoft.Identity.Abstractions.IAuthorizationHeaderProvider1
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
#nullable enable
Microsoft.Identity.Abstractions.IAuthorizationHeaderBoundProvider
Microsoft.Identity.Abstractions.IAuthorizationHeaderProvider1
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
#nullable enable
Microsoft.Identity.Abstractions.IAuthorizationHeaderBoundProvider
Microsoft.Identity.Abstractions.IAuthorizationHeaderProvider1
2 changes: 1 addition & 1 deletion src/Microsoft.Identity.Abstractions/Structure.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ TokenAcquisition
DownstreamApis
- AuthorizationHeaderProviderOptions
- IAuthorizationHeaderProvider
- IAuthorizationHeaderBoundProvider
- IAuthorizationHeaderProvider1
- IDownstreamApi
- DownstreamApiOptions
- DownstreamApiOptionsReadOnlyHttpMethod
Expand Down
Loading