Class MicrosoftIdentityAuthenticationBaseOptions

Namespace

Microsoft.Identity.Web

Assembly

Microsoft.Identity.Web.dll

Base options passed-in to authenticate with Microsoft Identity.

public class MicrosoftIdentityAuthenticationBaseOptions

Inheritance

object

MicrosoftIdentityAuthenticationBaseOptions

Derived

DownstreamWebApiOptions

MicrosoftIdentityAuthenticationMessageHandlerOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MicrosoftIdentityAuthenticationBaseOptions()

Constructor

protected MicrosoftIdentityAuthenticationBaseOptions()

Properties

AuthenticationScheme

Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.

public string? AuthenticationScheme { get; set; }

Property Value

string

IsProofOfPossessionRequest

Modifies the token acquisition request so that the acquired token is a Proof of Possession token (PoP), rather than a Bearer token. PoP tokens are similar to Bearer tokens, but are bound to the HTTP request and to a cryptographic key, which MSAL can manage. See https://aka.ms/msal-net-pop. Set to true to enable PoP tokens automatically.

public bool IsProofOfPossessionRequest { get; set; }

Property Value

bool

Scopes

Space separated scopes required to call the downstream web API. For instance "user.read mail.read".

public string? Scopes { get; set; }

Property Value

string

Tenant

[Optional] tenant ID. This is used for specific scenarios where the application needs to call a downstream web API on behalf of a user in several tenants. It would mostly be used from code, not from the configuration.

public string? Tenant { get; set; }

Property Value

string

TokenAcquisitionOptions

Options passed-in to create the token acquisition object which calls into MSAL .NET.

public TokenAcquisitionOptions TokenAcquisitionOptions { get; set; }

Property Value

TokenAcquisitionOptions

UserFlow

[Optional]. User flow (in the case of a B2C downstream web API). If not specified, the B2C downstream web API will be called with the default user flow from Microsoft.Identity.Web.MicrosoftIdentityOptions.DefaultUserFlow.

public string? UserFlow { get; set; }

Property Value

string

Methods

GetScopes()

Returns the scopes.

public string[] GetScopes()

Returns

string[]

Scopes.