Class AppServicesAuthenticationTokenAcquisition

Namespace

Microsoft.Identity.Web

Assembly

Microsoft.Identity.Web.dll

Implementation of ITokenAcquisition for App Services authentication (EasyAuth).

public class AppServicesAuthenticationTokenAcquisition : ITokenAcquisition

Inheritance

object

AppServicesAuthenticationTokenAcquisition

Implements

ITokenAcquisition

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AppServicesAuthenticationTokenAcquisition(IMsalTokenCacheProvider, IHttpContextAccessor, IHttpClientFactory)

Constructor of the AppServicesAuthenticationTokenAcquisition.

public AppServicesAuthenticationTokenAcquisition(IMsalTokenCacheProvider tokenCacheProvider, IHttpContextAccessor httpContextAccessor, IHttpClientFactory httpClientFactory)

Parameters

tokenCacheProvider IMsalTokenCacheProvider

The App token cache provider.

httpContextAccessor IHttpContextAccessor

Access to the HttpContext of the request.

httpClientFactory IHttpClientFactory

HTTP client factory.

Methods

GetAccessTokenForAppAsync(string, string?, string?, TokenAcquisitionOptions?)

public Task<string> GetAccessTokenForAppAsync(string scope, string? authenticationScheme, string? tenant = null, TokenAcquisitionOptions? tokenAcquisitionOptions = null)

Parameters

scope string

authenticationScheme string

tenant string

tokenAcquisitionOptions TokenAcquisitionOptions

Returns

Task<string>

GetAccessTokenForUserAsync(IEnumerable<string>, string?, string?, string?, ClaimsPrincipal?, TokenAcquisitionOptions?)

public Task<string> GetAccessTokenForUserAsync(IEnumerable<string> scopes, string? authenticationScheme, string? tenantId = null, string? userFlow = null, ClaimsPrincipal? user = null, TokenAcquisitionOptions? tokenAcquisitionOptions = null)

Parameters

scopes IEnumerable<string>

authenticationScheme string

tenantId string

userFlow string

user ClaimsPrincipal

tokenAcquisitionOptions TokenAcquisitionOptions

Returns

Task<string>

GetAuthenticationResultForAppAsync(string, string?, string?, TokenAcquisitionOptions?)

public Task<AuthenticationResult> GetAuthenticationResultForAppAsync(string scope, string? authenticationScheme, string? tenant = null, TokenAcquisitionOptions? tokenAcquisitionOptions = null)

Parameters

scope string

authenticationScheme string

tenant string

tokenAcquisitionOptions TokenAcquisitionOptions

Returns

Task<AuthenticationResult>

GetAuthenticationResultForUserAsync(IEnumerable<string>, string?, string?, string?, ClaimsPrincipal?, TokenAcquisitionOptions?)

public Task<AuthenticationResult> GetAuthenticationResultForUserAsync(IEnumerable<string> scopes, string? authenticationScheme, string? tenantId = null, string? userFlow = null, ClaimsPrincipal? user = null, TokenAcquisitionOptions? tokenAcquisitionOptions = null)

Parameters

scopes IEnumerable<string>

authenticationScheme string

tenantId string

userFlow string

user ClaimsPrincipal

tokenAcquisitionOptions TokenAcquisitionOptions

Returns

Task<AuthenticationResult>

GetEffectiveAuthenticationScheme(string?)

public string GetEffectiveAuthenticationScheme(string? authenticationScheme)

Parameters

authenticationScheme string

Returns

string

ReplyForbiddenWithWwwAuthenticateHeader(IEnumerable<string>, MsalUiRequiredException, string?, HttpResponse?)

public void ReplyForbiddenWithWwwAuthenticateHeader(IEnumerable<string> scopes, MsalUiRequiredException msalServiceException, string? authenticationScheme, HttpResponse? httpResponse = null)

Parameters

scopes IEnumerable<string>

msalServiceException MsalUiRequiredException

authenticationScheme string

httpResponse HttpResponse

ReplyForbiddenWithWwwAuthenticateHeaderAsync(IEnumerable<string>, MsalUiRequiredException, HttpResponse?)

public Task ReplyForbiddenWithWwwAuthenticateHeaderAsync(IEnumerable<string> scopes, MsalUiRequiredException msalServiceException, HttpResponse? httpResponse = null)

Parameters

scopes IEnumerable<string>

msalServiceException MsalUiRequiredException

httpResponse HttpResponse

Returns

Task