IAuthorizationHeaderProvider.CreateAuthorizationHeaderAsync Method

  • Reference

Definition

Namespace:
Microsoft.Identity.Abstractions
Assembly:
Microsoft.Identity.Abstractions.dll
Package:
Microsoft.Identity.Abstractions v6.0.0

Creates an authorization header for calling a protected web API on behalf of a user or the application.

public System.Threading.Tasks.Task<string> CreateAuthorizationHeaderAsync (System.Collections.Generic.IEnumerable<string> scopes, Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions? options = default, System.Security.Claims.ClaimsPrincipal? claimsPrincipal = default, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateAuthorizationHeaderAsync : seq<string> * Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions * System.Security.Claims.ClaimsPrincipal * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
Public Function CreateAuthorizationHeaderAsync (scopes As IEnumerable(Of String), Optional options As AuthorizationHeaderProviderOptions = Nothing, Optional claimsPrincipal As ClaimsPrincipal = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)

Parameters

scopes
IEnumerable<String>

The scopes for which to request the authorization header. Provide a single scope if the header needs to be created on behalf of an application.

options
AuthorizationHeaderProviderOptions

The AuthorizationHeaderProviderOptions containing information about the API to be called and token acquisition settings. If not provided, the header will be for a bearer token.

claimsPrincipal
ClaimsPrincipal

Inbound authentication elements. In a web API, this is usually the result of the validation of a token. In a web app, this would be information about the signed-in user. This is not useful in daemon applications. In Microsoft.Identity.Web you rarely need to provide this parameter as it's inferred from the context.

cancellationToken
CancellationToken

A token to cancel the operation.

Returns

Task<String>

A string containing the authorization header, such as "Bearer token" or "PoP token".

Applies to