Share via

ApplicationOptions Class

  • Reference

Definition

Namespace:
Microsoft.Identity.Client
Assembly:
Microsoft.Identity.Client.dll
Package:
Microsoft.Identity.Client v4.66.2

Base class for options objects with string values loadable from a configuration file (for instance a JSON file, as in an asp.net configuration scenario) See https://aka.ms/msal-net-application-configuration See also derived classes PublicClientApplicationOptions and ConfidentialClientApplicationOptions

public abstract class ApplicationOptions : Microsoft.Identity.Client.BaseApplicationOptions
type ApplicationOptions = class
    inherit BaseApplicationOptions
Public MustInherit Class ApplicationOptions
Inherits BaseApplicationOptions
Inheritance
Object
BaseApplicationOptions
ApplicationOptions
Derived

Constructors

ApplicationOptions()

Properties

AadAuthorityAudience

Sign-in audience. This property is mutually exclusive with TenantId. If both are provided, an exception will be thrown.
AzureCloudInstance

Specific instance in the case of Azure Active Directory. It allows users to use the enum instead of the explicit URL. This property is mutually exclusive with Instance. If both are provided, an exception will be thrown.
ClientCapabilities

Microsoft Identity specific OIDC extension that allows resource challenges to be resolved without interaction. Allows configuration of one or more client capabilities, e.g. "llt"
ClientId

Client ID (also known as App ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)
ClientName

The name of the calling application for telemetry purposes.
ClientVersion

The version of the calling application for telemetry purposes.
EnablePiiLogging

Flag to enable/disable logging of Personally Identifiable Information (PII). PII logs are never written to default outputs like Console, Logcat or NSLog Default is set to false, which ensures that your application is compliant with GDPR. You can set it to true for advanced debugging requiring PII. See https://aka.ms/msal-net-logging

(Inherited from BaseApplicationOptions)
Instance

STS instance (for instance https://login.microsoftonline.com for the Azure public cloud). The name was chosen to ensure compatibility with AzureAdOptions in ASP.NET Core. This property is mutually exclusive with AzureCloudInstance. If both are provided, an exception will be thrown.
IsDefaultPlatformLoggingEnabled

Flag to enable/disable logging to platform defaults. In Desktop, Event Tracing is used. In iOS, NSLog is used. In Android, logcat is used. The default value is false. See https://aka.ms/msal-net-logging

(Inherited from BaseApplicationOptions)
KerberosServicePrincipalName

Service principal name for Kerberos Service Ticket.
LegacyCacheCompatibilityEnabled

Enables legacy ADAL cache serialization and deserialization.
LogLevel

Enables you to configure the level of logging you want. The default value is Info. Setting it to Error will only get errors Setting it to Warning will get errors and warning, etc.. See https://aka.ms/msal-net-logging

(Inherited from BaseApplicationOptions)
RedirectUri

This redirect URI needs to be registered in the app registration. See https://aka.ms/msal-net-register-app for details on which redirect URIs are defined by default by MSAL.NET and how to register them. Also use: WithDefaultRedirectUri() which provides a good default for public client applications for all platforms.

For web apps and web APIs, the redirect URI is computed from the URL where the application is running (for instance, baseUrl//signin-oidc for ASP.NET Core web apps).

For daemon applications (confidential client applications using only the Client Credential flow that is calling AcquireTokenForClient), no reply URI is needed.
TenantId

Tenant from which the application will allow users to sign it. This can be: a domain associated with a tenant, a GUID (tenant id), or a meta-tenant (e.g. consumers). This property is mutually exclusive with AadAuthorityAudience. If both are provided, an exception will be thrown.
TicketContainer

Kerberos Service Ticket container to be used.

Applies to