netFramework/Microsoft.Identity.Client.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Identity.Client</name> </assembly> <members> <member name="T:Microsoft.Identity.Client.Account"> <summary> Contains information of a single account. A user can be present in multiple directories and thus have multiple accounts. This information is used for token cache lookup and enforcing the user session on the STS authorize endpoint. </summary> </member> <member name="M:Microsoft.Identity.Client.Account.#ctor(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IEnumerable{Microsoft.Identity.Client.TenantProfile})"> <summary> Constructor </summary> <param name="homeAccountId">Home account id in "uid.utid" format; can be null, for example when migrating the ADAL v3 cache</param> <param name="username">UPN style , can be null</param> <param name="environment">Identity provider for this account, e.g. <c>login.microsoftonline.com</c></param> <param name="wamAccountIds">Map of (client_id, wam_account_id)</param> <param name="tenantProfiles">Map of (tenant_id, tenant_profile)</param> </member> <member name="P:Microsoft.Identity.Client.Account.TenantProfiles"> <summary> The same account can exist in its home tenant and also as a guest in multiple other tenants. A <see cref="T:Microsoft.Identity.Client.TenantProfile"/> is derived from the ID token for that tenant. </summary> </member> <member name="T:Microsoft.Identity.Client.AccountExtensions"> <summary> Extension methods for <see cref="T:Microsoft.Identity.Client.IAccount"/> </summary> </member> <member name="M:Microsoft.Identity.Client.AccountExtensions.GetTenantProfiles(Microsoft.Identity.Client.IAccount)"> <summary> The same account can exist in its home tenant and also as a guest in multiple other tenants. <see cref="T:Microsoft.Identity.Client.TenantProfile"/> is derived from the ID token for that tenant. </summary> <remarks>Only tenants for which a token was acquired will be available in <c>TenantProfiles</c> property</remarks> </member> <member name="T:Microsoft.Identity.Client.AccountId"> <summary> An identifier for an account in a specific tenant. Returned by <see cref="P:IAccount.HomeAccountId"/> </summary> </member> <member name="P:Microsoft.Identity.Client.AccountId.Identifier"> <summary> Unique identifier for the account </summary> <remarks> For the Microsoft identity platform (formerly named Azure AD v2.0), the identifier is the concatenation of <see cref="P:Microsoft.Identity.Client.AccountId.ObjectId"/> and <see cref="P:Microsoft.Identity.Client.AccountId.TenantId"/> separated by a dot. Contrary to what was happening in ADAL.NET, these two segments are no longer base64 encoded. Note that there are some legitimate cases (for instance domain takeover), where the same ObjectId may show up in multiple tenants. </remarks> </member> <member name="P:Microsoft.Identity.Client.AccountId.ObjectId"> <summary> For Azure AD, a string representation for a GUID which is the Object ID of the user owning the account in the tenant </summary> </member> <member name="P:Microsoft.Identity.Client.AccountId.TenantId"> <summary> For Azure AD, a string representation for a GUID, which is the ID of the tenant where the account resides. </summary> </member> <member name="M:Microsoft.Identity.Client.AccountId.#ctor(System.String,System.String,System.String)"> <summary> Constructor of an AccountId </summary> <param name="identifier">Unique identifier for the account.</param> <param name="objectId">A string representation for a GUID which is the ID of the user owning the account in the tenant</param> <param name="tenantId">A string representation for a GUID, which is the ID of the tenant where the account resides</param> </member> <member name="M:Microsoft.Identity.Client.AccountId.#ctor(System.String)"> <summary> Constructor of an AccountId meant for ADFS scenarios since ADFS instances lack tenant ids. </summary> <param name="adfsIdentifier">Unique identifier for the account if authority is ADFS</param> </member> <member name="M:Microsoft.Identity.Client.AccountId.Equals(System.Object)"> <summary> Two accounts are equal when their <see cref="P:Microsoft.Identity.Client.AccountId.Identifier"/> properties match </summary> </member> <member name="M:Microsoft.Identity.Client.AccountId.GetHashCode"> <summary> GetHashCode implementation to match <see cref="M:Microsoft.Identity.Client.AccountId.Equals(System.Object)"/> </summary> </member> <member name="M:Microsoft.Identity.Client.AccountId.ToString"> <summary> Textual description of an <see cref="T:Microsoft.Identity.Client.AccountId"/> </summary> </member> <member name="T:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1"> <inheritdoc/> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.#ctor"> <summary> Default constructor for AbstractAcquireTokenParameterBuilder. </summary> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithScopes(System.Collections.Generic.IEnumerable{System.String})"> <summary> Specifies which scopes to request. This method is used when your application needs to specify the scopes needed to call a protected API. See <see>https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent</see> to learn more about scopes, permissions and consent, and <see>https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes</see> to learn how to create scopes for legacy applications which used to expose OAuth2 permissions. </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"> <summary> Sets Extra Query Parameters for the query string in the HTTP authentication request. </summary> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority as a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithClaims(System.String)"> <summary> Sets claims in the query. Use when the AAD admin has enabled conditional access. Acquiring the token normally will result in a <see cref="T:Microsoft.Identity.Client.MsalUiRequiredException"/> with the <see cref="P:Microsoft.Identity.Client.MsalServiceException.Claims"/> property set. Retry the token acquisition, and use this value in the <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithClaims(System.String)"/> method. See https://aka.ms/msal-exceptions for details as well as https://aka.ms/msal-net-claim-challenge. </summary> <param name="claims">A string with one or multiple claims.</param> <returns>The builder to chain .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.String)"> <summary> Sets Extra Query Parameters for the query string in the HTTP authentication request. </summary> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The string needs to be properly URL-encoded and ready to send as a string of segments of the form <c>key=value</c> separated by an ampersand character. </param> <returns>The builder to chain .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"> <summary> Important: Use WithTenantId or WithTenantIdFromAuthority instead, or WithB2CAuthority for B2C authorities. Specific authority for which the token is requested. Passing a different value than configured at the application constructor narrows down the selection to a specific tenant. This does not change the configured value in the application. This is specific to applications managing several accounts (like a mail client with several mailboxes). See https://aka.ms/msal-net-application-configuration. </summary> <param name="authorityUri">Uri for the authority. In the case when the authority URI is a known Azure AD URI, this setting needs to be consistent with what is declared in the application registration portal.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Guid,System.Boolean)"> <summary> Important: Use WithTenantId or WithTenantIdFromAuthority instead, or WithB2CAuthority for B2C authorities. Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) specified by its tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="cloudInstanceUri">Azure Cloud instance.</param> <param name="tenantId">GUID of the tenant from which to sign-in users.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.String,System.Boolean)"> <summary> Important: Use WithTenantId or WithTenantIdFromAuthority instead, or WithB2CAuthority for B2C authorities. Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its domain name. See https://aka.ms/msal-net-application-configuration. </summary> <param name="cloudInstanceUri">Uri to the Azure Cloud instance (for instance <c>https://login.microsoftonline.com)</c>.</param> <param name="tenant">Tenant Id associated with the tenant from which to sign-in users.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <remarks> <paramref name="tenant"/> can also contain the string representation of a GUID (tenantId), or even <c>common</c>, <c>organizations</c> or <c>consumers</c> but in this case it's recommended to use another override (<see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.Guid,System.Boolean)"/> and <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"/> </remarks> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.Guid,System.Boolean)"> <summary> Important: Use WithTenantId or WithTenantIdFromAuthority instead, or WithB2CAuthority for B2C authorities. Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its cloud instance and its tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...).</param> <param name="tenantId">Tenant Id of the tenant from which to sign-in users.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.String,System.Boolean)"> <summary> Important: Use WithTenantId or WithTenantIdFromAuthority instead, or WithB2CAuthority for B2C authorities. Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its cloud instance and its domain name or tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...).</param> <param name="tenant">Tenant Id of the tenant from which to sign-in users. This can also be a GUID.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users specifying the cloud instance and the sign-in audience. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...).</param> <param name="authorityAudience">Sign-in audience (one AAD organization, any work and school accounts, or any work and school accounts and Microsoft personal accounts.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"> <summary> Important: Use WithTenantId or WithTenantIdFromAuthority instead, or WithB2CAuthority for B2C authorities. Adds a known Azure AD authority to the application to sign-in users specifying the sign-in audience (the cloud being the Azure public cloud). See https://aka.ms/msal-net-application-configuration. </summary> <param name="authorityAudience">Sign-in audience (one AAD organization, any work and school accounts, or any work and school accounts and Microsoft personal accounts.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"> <summary> Overrides the tenant ID specified in the authority at the application level. This operation preserves the authority host (environment). If an authority was not specified at the application level, the default used is https://login.microsoftonline.com/common. </summary> <param name="tenantId">The tenant ID, which can be either in GUID format or a domain name. Also known as the Directory ID.</param> <returns>The builder to chain the .With methods.</returns> <exception cref="T:System.ArgumentNullException">Thrown if tenantId is null or an empty string</exception> <exception cref="T:Microsoft.Identity.Client.MsalClientException">Thrown if the application was configured with an authority that is not AAD specific (e.g. ADFS or B2C).</exception> <remarks> The tenant should be more restrictive than the one configured at the application level, e.g. don't use "common". Does not affect authority validation, which is specified at the application level.</remarks> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantIdFromAuthority(System.Uri)"> <summary> Extracts the tenant ID from the provided authority URI and overrides the tenant ID specified in the authority at the application level. This operation preserves the authority host (environment) provided to the application builder. If an authority was not provided to the application builder, this method will replace the tenant ID in the default authority - https://login.microsoftonline.com/common. </summary> <param name="authorityUri">URI from which to extract the tenant ID</param> <returns>The builder to chain the .With methods.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="authorityUri"/> is null or an empty string</exception> <exception cref="T:Microsoft.Identity.Client.MsalClientException">Thrown if the application was configured with an authority that is not AAD specific (e.g. ADFS or B2C).</exception> <remarks> The tenant should be more restrictive than the one configured at the application level, e.g. don't use "common". Does not affect authority validation, which is specified at the application level.</remarks> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAdfsAuthority(System.String,System.Boolean)"> <summary> Adds a known Authority corresponding to an ADFS server. See https://aka.ms/msal-net-adfs. </summary> <param name="authorityUri">Authority URL for an ADFS server.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <remarks>MSAL.NET supports ADFS 2019 or later.</remarks> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithB2CAuthority(System.String)"> <summary> Adds a known authority corresponding to an Azure AD B2C policy. See https://aka.ms/msal-net-b2c-specificities </summary> <param name="authorityUri">Azure AD B2C authority, including the B2C policy (for instance <c>"https://fabrikamb2c.b2clogin.com/tfp/{Tenant}/{policy}</c></param>). <returns>The builder to chain the .With methods.</returns> </member> <member name="T:Microsoft.Identity.Client.AbstractClientAppBaseAcquireTokenParameterBuilder`1"> <summary> Base class for parameter builders common to public client application and confidential client application token acquisition operations </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractClientAppBaseAcquireTokenParameterBuilder`1.ExecuteAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1"> <summary> Base class for confidential client application token request builders </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1.ExecuteAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1.Validate"> <summary> Validates the parameters of the AcquireToken operation. </summary> <exception cref="T:Microsoft.Identity.Client.MsalClientException"></exception> </member> <member name="M:Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1.WithProofOfPossession(Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration)"> <summary> 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 on Windows. See https://aka.ms/msal-net-pop </summary> <param name="popAuthenticationConfiguration">Configuration properties used to construct a Proof-of-Possession request.</param> <returns>The builder.</returns> <remarks> <list type="bullet"> <item><description>An Authentication header is automatically added to the request.</description></item> <item><description>The PoP token is bound to the HTTP request, more specifically to the HTTP method (GET, POST, etc.) and to the Uri (path and query, but not query parameters).</description></item> <item><description>MSAL creates, reads and stores a key in memory that will be cycled every 8 hours.</description></item> <item><description>This is an experimental API. The method signature may change in the future without involving a major version upgrade.</description></item> </list> </remarks> </member> <member name="T:Microsoft.Identity.Client.AbstractManagedIdentityAcquireTokenParameterBuilder`1"> <summary> Abstract base class for managed identity application token request builders. </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractManagedIdentityAcquireTokenParameterBuilder`1.#ctor"> <summary> Default constructor for AbstractManagedIdentityParameterBuilder. </summary> </member> <member name="M:Microsoft.Identity.Client.AbstractManagedIdentityAcquireTokenParameterBuilder`1.ExecuteAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder`1"> <summary> Base class for public client application token request builders </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder`1.ExecuteAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="P:Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder`1.PublicClientApplicationExecutor"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder"> <summary> Builder for AcquireTokenByAuthorizationCode </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.CalculateApiEventId"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.WithSendX5C(System.Boolean)"> <summary> Applicable to first-party applications only, this method also allows to specify if the <see href="https://datatracker.ietf.org/doc/html/rfc7517#section-4.7">x5c claim</see> should be sent to Azure AD. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the certificate chain to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="withSendX5C"><c>true</c> if the x5c should be sent. Otherwise <c>false</c>. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.WithPkceCodeVerifier(System.String)"> <summary> Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). See (https://tools.ietf.org/html/rfc7636) for more details. </summary> <param name="pkceCodeVerifier">A dynamically created cryptographically random key used to provide proof of possession for the authorization code. </param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.WithCcsRoutingHint(System.String,System.String)"> <summary> To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide backup authentication system with a routing hint to help improve performance during authentication. </summary> <param name="userObjectIdentifier">GUID which is unique to the user, parsed from the client_info.</param> <param name="tenantIdentifier">GUID format of the tenant ID, parsed from the client_info.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.WithCcsRoutingHint(System.String)"> <summary> To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide backup authentication system with a routing hint to help improve performance during authentication. </summary> <param name="userName">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByAuthorizationCodeParameterBuilder.WithSpaAuthorizationCode(System.Boolean)"> <summary> Requests an auth code for the frontend (SPA using MSAL.js for instance). See https://aka.ms/msal-net/spa-auth-code for details. </summary> <param name="requestSpaAuthorizationCode "><c>true</c> if a SPA Authorization Code should be returned, <c>false</c></param> otherwise. <returns>The builder to chain the .With methods</returns> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder"> <summary> Builder for AcquireTokenByIntegratedWindowsAuth </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IPublicClientApplicationExecutor)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.WithUsername(System.String)"> <summary> Specifies the username. </summary> <param name="username">Identifier of the user account for which to acquire a token with Integrated Windows authentication. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.WithFederationMetadata(System.String)"> <summary> Enables MSAL to read the federation metadata for a WS-Trust exchange from the provided input instead of acquiring it from an endpoint. This is only applicable for managed ADFS accounts. See https://aka.ms/MsalFederationMetadata. </summary> <param name="federationMetadata">Federation metadata in the form of XML.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.CalculateApiEventId"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder"> <summary> Parameter builder for the <see cref="M:Microsoft.Identity.Client.IByRefreshToken.AcquireTokenByRefreshToken(System.Collections.Generic.IEnumerable{System.String},System.String)"/> method. See https://aka.ms/msal-net-migration-adal2-msal2 </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IClientApplicationBaseExecutor)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder.CalculateApiEventId"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByRefreshTokenParameterBuilder.WithSendX5C(System.Boolean)"> <summary> Applicable to first-party applications only, this method also allows to specify if the <see href="https://datatracker.ietf.org/doc/html/rfc7517#section-4.7">x5c claim</see> should be sent to Azure AD. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the certificate chain to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="withSendX5C"><c>true</c> if the x5c should be sent. Otherwise <c>false</c>. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder"> <summary> Parameter builder for the <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"/> operation. See https://aka.ms/msal-net-up </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder.WithFederationMetadata(System.String)"> <summary> Enables MSAL to read the federation metadata for a WS-Trust exchange from the provided input instead of acquiring it from an endpoint. This is only applicable for managed ADFS accounts. See https://aka.ms/MsalFederationMetadata. </summary> <param name="federationMetadata">Federation metadata in the form of XML.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder.WithProofOfPossession(System.String,System.Net.Http.HttpMethod,System.Uri)"> <summary> 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 on Windows. Note that only the host and path parts of the request URI will be bound. See https://aka.ms/msal-net-pop </summary> <param name="nonce">Nonce of the protected resource (RP) which will be published as part of the WWWAuthenticate header associated with a 401 HTTP response or as part of the AuthorityInfo header associated with 200 response. Set it here to make it part of the Signed HTTP Request part of the POP token.</param> <param name="httpMethod">The HTTP method ("GET", "POST" etc.) method that will be bound to the token. If set to null, the PoP token will not be bound to the method. Corresponds to the "m" part of the a signed HTTP request.</param> <param name="requestUri">The URI to bind the signed HTTP request to.</param> <returns>The builder.</returns> <remarks> <list type="bullet"> <item><description>An Authentication header is automatically added to the request.</description></item> <item><description>The PoP token is bound to the HTTP request, more specifically to the HTTP method (GET, POST, etc.) and to the Uri (path and query, but not query parameters).</description></item> <item><description>Broker is required to use Proof-of-Possession on public clients.</description></item> </list> </remarks> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenByUsernamePasswordParameterBuilder.CalculateApiEventId"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder"> <summary> Builder for AcquireTokenForClient (used in client credential flows, in daemon applications). See https://aka.ms/msal-net-client-credentials </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IConfidentialClientApplicationExecutor)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithForceRefresh(System.Boolean)"> <summary> Specifies if the token request will ignore the access token in the application token cache and will attempt to acquire a new access token using client credentials. By default the token is taken from the application token cache (forceRefresh=false) </summary> <param name="forceRefresh">If <c>true</c>, the request will ignore the token cache. The default is <c>false</c> </param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithSendX5C(System.Boolean)"> <summary> Applicable to first-party applications only, this method also allows to specify if the <see href="https://datatracker.ietf.org/doc/html/rfc7517#section-4.7">x5c claim</see> should be sent to Azure AD. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the certificate chain to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="withSendX5C"><c>true</c> if the x5c should be sent. Otherwise <c>false</c>. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithAzureRegion(System.Boolean)"> <summary> Please use WithAzureRegion on the ConfidentialClientApplicationBuilder object </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithPreferredAzureRegion(System.Boolean,System.String,System.Boolean)"> <summary> Please use WithAzureRegion on the ConfidentialClientApplicationBuilder object </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.CalculateApiEventId"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenForManagedIdentityParameterBuilder"> <summary> Builder for AcquireTokenForManagedIdentity (used to get token for managed identities). See https://aka.ms/msal-net-managed-identity </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForManagedIdentityParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IManagedIdentityApplicationExecutor)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForManagedIdentityParameterBuilder.WithForceRefresh(System.Boolean)"> <summary> Specifies if the token request will ignore the access token in the application token cache and will attempt to acquire a new access token for managed identity. By default the token is taken from the application token cache (forceRefresh=false) </summary> <param name="forceRefresh">If <c>true</c>, the request will ignore the token cache. The default is <c>false</c> </param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForManagedIdentityParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenForManagedIdentityParameterBuilder.CalculateApiEventId"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder"> <summary> Builder for an Interactive token request. See https://aka.ms/msal-net-acquire-token-interactively </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithUseEmbeddedWebView(System.Boolean)"> <summary> Specifies if the public client application should used an embedded web browser or the system default browser </summary> <param name="useEmbeddedWebView">If <c>true</c>, will use an embedded web browser, otherwise will attempt to use a system web browser. The default depends on the platform: <c>false</c> for Xamarin.iOS and Xamarin.Android, and <c>true</c> for .NET Framework, and UWP</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithSystemWebViewOptions(Microsoft.Identity.Client.SystemWebViewOptions)"> <summary> Specifies options for using the system OS browser handle interactive authentication. </summary> <param name="options">Data object with options</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithEmbeddedWebViewOptions(Microsoft.Identity.Client.EmbeddedWebViewOptions)"> <summary> Specifies options for using the embedded web view for interactive authentication. </summary> <param name="options">Data object with options</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithLoginHint(System.String)"> <summary> Sets the <paramref name="loginHint"/>, in order to avoid select account dialogs in the case the user is signed-in with several identities. This method is mutually exclusive with <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"/>. If both are used, an exception will be thrown </summary> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"> <summary> Sets the account for which the token will be retrieved. This method is mutually exclusive with <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithLoginHint(System.String)"/>. If both are used, an exception will be thrown </summary> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"> <summary> </summary> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected Web API for which you want to acquire a security token.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithPrompt(Microsoft.Identity.Client.Prompt)"> <summary> Specifies the what the interactive experience is for the user. </summary> <param name="prompt">Requested interactive experience. The default is <see cref="F:Microsoft.Identity.Client.Prompt.SelectAccount"/> </param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithParentActivityOrWindow(System.Object)"> <summary> Sets a reference to the ViewController (if using Xamarin.iOS), Activity (if using Xamarin.Android) IWin32Window or IntPtr (if using .Net Framework). Used for invoking the browser. </summary> <remarks>Mandatory only on Android. Can also be set via the PublicClientApplication builder.</remarks> <param name="parent">The parent as an object, so that it can be used from shared NetStandard assemblies</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithParentActivityOrWindow(System.Windows.Forms.IWin32Window)"> <summary> Sets a reference to the current IWin32Window that triggers the browser to be shown. Used to center the browser (embedded web view and Windows broker) that pop-up onto this window. </summary> <param name="window">The current window as a IWin32Window</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithParentActivityOrWindow(System.IntPtr)"> <summary> Sets a reference to the IntPtr to a window that triggers the browser to be shown. Used to center the browser that pop-up onto this window. The center of the screen or the foreground app if a value is configured. </summary> <param name="window">The current window as IntPtr</param> <returns>The builder to chain the .With methods</returns> <remarks></remarks> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithProofOfPossession(System.String,System.Net.Http.HttpMethod,System.Uri)"> <summary> 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 on Windows. Note that only the host and path parts of the request URI will be bound. See https://aka.ms/msal-net-pop </summary> <param name="nonce">Nonce of the protected resource which will be published as part of the WWW-Authenticate header associated with a 401 HTTP response or as part of the AuthorityInfo header associated with 200 response. Set it here to make it part of the Signed HTTP Request part of the PoP token.</param> <param name="httpMethod">The HTTP method ("GET", "POST" etc.) method that will be bound to the token. If set to null, the PoP token will not be bound to the method. Corresponds to the "m" part of the a signed HTTP request.</param> <param name="requestUri">The URI to bind the signed HTTP request to.</param> <returns>The builder.</returns> <remarks> <list type="bullet"> <item><description>An Authentication header is automatically added to the request.</description></item> <item><description>The PoP token is bound to the HTTP request, more specifically to the HTTP method (GET, POST, etc.) and to the Uri (path and query, but not query parameters).</description></item> <item><description>Broker is required to use Proof-of-Possession on public clients.</description></item> </list> </remarks> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder"> <summary> Builder for AcquireTokenOnBehalfOf (OBO flow) See https://aka.ms/msal-net-on-behalf-of </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IConfidentialClientApplicationExecutor)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithCacheKey(System.String)"> <summary> Specifies a key by which to look up the token in the cache instead of searching by an assertion. </summary> <param name="cacheKey">Key by which to look up the token in the cache</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithSendX5C(System.Boolean)"> <summary> Applicable to first-party applications only, this method also allows to specify if the <see href="https://datatracker.ietf.org/doc/html/rfc7517#section-4.7">x5c claim</see> should be sent to Azure AD. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the certificate chain to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="withSendX5C"><c>true</c> if the x5c should be sent. Otherwise <c>false</c>. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithForceRefresh(System.Boolean)"> <summary> Specifies if the client application should force refreshing the token from the user token cache. By default the token is taken from the the user token cache (forceRefresh=false) </summary> <param name="forceRefresh">If <c>true</c>, ignore any access token in the user token cache and attempt to acquire new access token using the refresh token for the account if one is available. This can be useful in the case when the application developer wants to make sure that conditional access policies are applied immediately, rather than after the expiration of the access token. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> <remarks>Avoid unnecessarily setting <paramref name="forceRefresh"/> to <c>true</c> true in order to avoid negatively affecting the performance of your application</remarks> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithCcsRoutingHint(System.String,System.String)"> <summary> To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide the AAD backup authentication system with a routing hint to help improve performance during authentication. </summary> <param name="userObjectIdentifier">GUID which is unique to the user, parsed from the client_info.</param> <param name="tenantIdentifier">GUID format of the tenant ID, parsed from the client_info.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.WithCcsRoutingHint(System.String)"> <summary> To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide the AAD backup authentication system with a routing hint to help improve performance during authentication. </summary> <param name="userName">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder.CalculateApiEventId"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder"> <inheritdoc/> <summary> Parameter builder for the <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> operation. See https://aka.ms/msal-net-acquiretokensilent </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"> <summary> Sets the account for which the token will be retrieved. This method is mutually exclusive with <see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithLoginHint(System.String)"/>. If both are used, an exception will be thrown </summary> <param name="account">Account to use for the silent token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <returns>The builder to chain the .With methods</returns> <remarks>An exception will be thrown If AAD returns a different account than the one that is being requested for.</remarks> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)"> <summary> Specifies if the client application should force refreshing the token from the user token cache. By default the token is taken from the the user token cache (forceRefresh=false) </summary> <param name="forceRefresh">If <c>true</c>, ignore any access token in the user token cache and attempt to acquire new access token using the refresh token for the account if one is available. This can be useful in the case when the application developer wants to make sure that conditional access policies are applied immediately, rather than after the expiration of the access token. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> <remarks>Avoid unnecessarily setting <paramref name="forceRefresh"/> to <c>true</c> true in order to avoid negatively affecting the performance of your application</remarks> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.CalculateApiEventId"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithSendX5C(System.Boolean)"> <summary> Applicable to first-party applications only, this method also allows to specify if the <see href="https://datatracker.ietf.org/doc/html/rfc7517#section-4.7">x5c claim</see> should be sent to Azure AD. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the certificate chain to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="withSendX5C"><c>true</c> if the x5c should be sent. Otherwise <c>false</c>. The default is <c>false</c></param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithProofOfPossession(Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration)"> <summary> 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 on Windows. See https://aka.ms/msal-net-pop </summary> <param name="popAuthenticationConfiguration">Configuration properties used to construct a Proof-of-Possession request.</param> <remarks> <list type="bullet"> <item><description>An Authentication header is automatically added to the request.</description></item> <item><description>The PoP token is bound to the HTTP request, more specifically to the HTTP method (GET, POST, etc.) and to the Uri (path and query, but not query parameters).</description></item> <item><description>MSAL creates, reads and stores a key in memory that will be cycled every 8 hours.</description></item> <item><description>This is an experimental API. The method signature may change in the future without involving a major version upgrade.</description></item> </list> </remarks> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithProofOfPossession(System.String,System.Net.Http.HttpMethod,System.Uri)"> <summary> 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 on Windows. Note that only the host and path parts of the request URI will be bound. See https://aka.ms/msal-net-pop </summary> <param name="nonce">Nonce of the protected resource (RP) which will be published as part of the WWWAuthenticate header associated with a 401 HTTP response or as part of the AuthorityInfo header associated with 200 response. Set it here to make it part of the Signed HTTP Request part of the POP token.</param> <param name="httpMethod">The HTTP method ("GET", "POST" etc.) method that will be bound to the token. If set to null, the PoP token will not be bound to the method. Corresponds to the "m" part of the a signed HTTP request.</param> <param name="requestUri">The URI to bind the signed HTTP request to.</param> <returns>The builder.</returns> <remarks> <list type="bullet"> <item><description>An Authentication header is automatically added to the request.</description></item> <item><description>The PoP token is bound to the HTTP request, more specifically to the HTTP method (GET, POST, etc.) and to the Uri (path and query, but not query parameters).</description></item> <item><description>MSAL creates, reads and stores a key in memory that will be cycled every 8 hours.</description></item> <item><description>On confidential clients, this is an experimental API. The method signature may change in the future without involving a major version upgrade.</description></item> <item><description>Broker is required to use Proof-of-Possession on public clients.</description></item> </list> </remarks> </member> <member name="T:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder"> <summary> Parameters builder for the <see cref="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCode(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"/> operation. See https://aka.ms/msal-net-device-code-flow </summary> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder.#ctor(Microsoft.Identity.Client.ApiConfig.Executors.IPublicClientApplicationExecutor)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder.WithDeviceCodeResultCallback(System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Sets the Callback delegate so your application can interact with the user to direct them to authenticate (to a specific URL, with a code) </summary> <param name="deviceCodeResultCallback">callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder.CalculateApiEventId"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.AcquireTokenWithDeviceCodeParameterBuilder.Validate"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.BaseAbstractAcquireTokenParameterBuilder`1"> <summary> Base class for builders of token requests, which attempt to acquire a token based on the provided parameters. </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractAcquireTokenParameterBuilder`1.#ctor"> <summary> Default constructor for AbstractAcquireTokenParameterBuilder. </summary> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractAcquireTokenParameterBuilder`1.ExecuteAsync(System.Threading.CancellationToken)"> <summary> Executes the Token request asynchronously, with a possibility of cancelling the asynchronous method. </summary> <param name="cancellationToken">Cancellation token. See <see cref="T:System.Threading.CancellationToken"/> </param> <returns>Authentication result containing a token for the requested scopes and parameters set in the builder.</returns> <remarks> <para> Cancellation is not guaranteed, it is best effort. If the operation reaches a point of no return, e.g. tokens are acquired and written to the cache, the task will complete even if cancellation was requested. Do not rely on cancellation tokens for strong consistency. </para> <para> To learn more about potential exceptions thrown by the function, refer to <see href="https://aka.ms/msal-net-exceptions">Exceptions in MSAL.NET</see>. </para> </remarks> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractAcquireTokenParameterBuilder`1.ExecuteAsync"> <summary> Executes the Token request asynchronously. </summary> <returns>Authentication result containing a token for the requested scopes and parameters set in the builder.</returns> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractAcquireTokenParameterBuilder`1.WithCorrelationId(System.Guid)"> <summary> Sets the correlation id to be used in the authentication request. Used to track a request in the logs of both the SDK and the Identity Provider service. If not set, a random one will be generated. </summary> <param name="correlationId">Correlation id of the authentication request.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractAcquireTokenParameterBuilder`1.Validate"> <summary> Validates the parameters of the AcquireToken operation. </summary> </member> <member name="T:Microsoft.Identity.Client.BrokerOptions"> <summary> The class specifies the options for broker across OperatingSystems The common properties are direct members Platform specific properties (if they exist) are part of the corresponding options </summary> </member> <member name="T:Microsoft.Identity.Client.BrokerOptions.OperatingSystems"> <summary> Supported OperatingSystems </summary> </member> <member name="F:Microsoft.Identity.Client.BrokerOptions.OperatingSystems.None"> <summary> No OS specified - Invalid options </summary> </member> <member name="F:Microsoft.Identity.Client.BrokerOptions.OperatingSystems.Windows"> <summary> Use broker on Windows OS </summary> </member> <member name="M:Microsoft.Identity.Client.BrokerOptions.#ctor(Microsoft.Identity.Client.BrokerOptions.OperatingSystems)"> <summary> Constructor </summary> <param name="enabledOn">Choices of OperatingSystems</param> </member> <member name="M:Microsoft.Identity.Client.BrokerOptions.CreateFromWindowsOptions(Microsoft.Identity.Client.WindowsBrokerOptions)"> <summary> Creates BrokerOptions from WindowsBrokerOptions </summary> </member> <member name="P:Microsoft.Identity.Client.BrokerOptions.EnabledOn"> <summary> Operating systems on which broker is enabled. </summary> </member> <member name="P:Microsoft.Identity.Client.BrokerOptions.Title"> <summary> Title of the broker window </summary> </member> <member name="P:Microsoft.Identity.Client.BrokerOptions.MsaPassthrough"> <summary> A legacy option available only to Microsoft First-Party applications. Should be avoided where possible. </summary> <remarks>This is a convenience API, the same can be achieved by using WithExtraQueryParameters and passing the extra query parameter "msal_request_type": "consumer_passthrough"</remarks> </member> <member name="P:Microsoft.Identity.Client.BrokerOptions.ListOperatingSystemAccounts"> <summary> Currently only supported on Windows Allows the Windows broker to list Work and School accounts as part of the <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync"/> </summary> </member> <member name="T:Microsoft.Identity.Client.EmbeddedWebViewOptions"> <summary> Options for using the embedded webview. </summary> </member> <member name="M:Microsoft.Identity.Client.EmbeddedWebViewOptions.#ctor"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.EmbeddedWebViewOptions.Title"> <summary> Forces a static title to be set on the window hosting the browser. If not configured, the widow's title is set to the web page title. </summary> <remarks>Currently only affects the windows desktop apps (WebView1 / Vulcan and WebView2 browser).</remarks> </member> <member name="P:Microsoft.Identity.Client.EmbeddedWebViewOptions.WebView2BrowserExecutableFolder"> <summary> It is possible for applications to bundle a fixed version of the runtime, and ship it side-by-side. For this you need to tell MSAL (so it can tell WebView2) where to find the runtime bits by setting this property. If you don't set it, MSAL will attempt to use a system-wide "evergreen" installation of the runtime." For more details see: https://docs.microsoft.com/en-us/dotnet/api/microsoft.web.webview2.core.corewebview2environment.createasync?view=webview2-dotnet-1.0.705.50 </summary> </member> <member name="T:Microsoft.Identity.Client.ApiConfig.Parameters.AbstractAcquireTokenConfidentialClientParameters"> <summary> Abstract class for confidential clients Supports common property(ies) </summary> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AbstractAcquireTokenConfidentialClientParameters.SendX5C"> <summary> Parameter sent to request to send X5C or not. This overrides application config settings. </summary> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AbstractAcquireTokenConfidentialClientParameters.SpaCode"> <summary> if <c>true</c> then Spa code param will be sent via AcquireTokenByAuthorizeCode </summary> </member> <member name="T:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenByIntegratedWindowsAuthParameters"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenByIntegratedWindowsAuthParameters.LogParameters(Microsoft.Identity.Client.Core.ILoggerAdapter)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenByUsernamePasswordParameters.LogParameters(Microsoft.Identity.Client.Core.ILoggerAdapter)"> <inheritdoc/> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenForClientParameters.ForceRefresh"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenForClientParameters.LogParameters(Microsoft.Identity.Client.Core.ILoggerAdapter)"> <inheritdoc/> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenInteractiveParameters.ExtraScopesToConsent"> <summary> These need to be asked for to the /authorize endpoint (for consent) but not to the /token endpoint </summary> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenOnBehalfOfParameters.UserAssertion"> <remarks> User assertion is null when <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable{System.String},System.String,System.String@)"/> is called. </remarks> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenOnBehalfOfParameters.LongRunningOboCacheKey"> <summary> User-provided cache key for long-running OBO flow. </summary> </member> <member name="P:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenOnBehalfOfParameters.SearchInCacheForLongRunningObo"> <summary> Only affects <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable{System.String},System.String,System.String@)"/>. When enabled, mimics MSAL 4.50.0 and below behavior - checks in cache for cached tokens first, and if not found, then uses user assertion to request new tokens from AAD. When disabled (default behavior), doesn't search in cache, but uses the user assertion to retrieve tokens from AAD. </summary> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenOnBehalfOfParameters.LogParameters(Microsoft.Identity.Client.Core.ILoggerAdapter)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenSilentParameters.LogParameters(Microsoft.Identity.Client.Core.ILoggerAdapter)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.AcquireTokenWithDeviceCodeParameters.LogParameters(Microsoft.Identity.Client.Core.ILoggerAdapter)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.ApiConfig.Parameters.GetAuthorizationRequestUrlParameters.LogParameters(Microsoft.Identity.Client.Core.ILoggerAdapter)"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder"> <summary> NOTE: a few of the methods in AbstractAcquireTokenParameterBuilder (e.g. account) don't make sense here. Do we want to create a further base that contains ALL of the common methods, and then have another one including account, etc that are only used for AcquireToken? </summary> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithRedirectUri(System.String)"> <summary> Sets the redirect URI to add to the Authorization request URL </summary> <param name="redirectUri">Address to return to upon receiving a response from the authority.</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithLoginHint(System.String)"> <summary> </summary> <param name="loginHint"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"> <summary> </summary> <param name="account"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"> <summary> </summary> <param name="extraScopesToConsent"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithPkce(System.String@)"> <summary> Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE). For more information, see the PKCE RCF: https://tools.ietf.org/html/rfc7636 </summary> <param name="codeVerifier">MSAL.NET will generate it. </param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithCcsRoutingHint(System.String,System.String)"> <summary> To help with resiliency, the AAD backup authentication system operates as an AAD backup. This will provide the AAD backup authentication system with a routing hint to help improve performance during authentication. The hint created with this api will take precedence over the one created with <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithLoginHint(System.String)"/> </summary> <param name="userObjectIdentifier">GUID which is unique to the user, parsed from the client_info.</param> <param name="tenantIdentifier">GUID format of the tenant ID, parsed from the client_info.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithPrompt(Microsoft.Identity.Client.Prompt)"> <summary> Specifies the interactive experience for the user. </summary> <param name="prompt">Requested interactive experience. The default is <see cref="F:Microsoft.Identity.Client.Prompt.SelectAccount"/> </param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.ExecuteInternalAsync(System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.ExecuteAsync(System.Threading.CancellationToken)"> <summary> </summary> <param name="cancellationToken"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.ExecuteAsync"> <summary> </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.CalculateApiEventId"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.SystemWebViewOptions"> <summary> Options for using the default OS browser as a separate process to handle interactive auth. MSAL will be listening for the OS browser to finish authenticating, but it cannot close the browser. It can however respond with a 200 OK message or a 302 Redirect, which can be configured here. For more details see https://aka.ms/msal-net-os-browser </summary> </member> <member name="M:Microsoft.Identity.Client.SystemWebViewOptions.#ctor"> <summary> Constructor </summary> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.HtmlMessageSuccess"> <summary> When the user finishes authenticating, MSAL will respond with a 200 OK message, which the browser will show to the user. </summary> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.HtmlMessageError"> <summary> When the user finishes authenticating, but an error occurred, MSAL will respond with a 200 OK message, which the browser will show to the user. You can use a string format e.g. "An error has occurred: {0} details: {1}" </summary> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.BrowserRedirectSuccess"> <summary> When the user finishes authenticating, MSAL will redirect the browser to the given Uri </summary> <remarks>Takes precedence over <see cref="P:Microsoft.Identity.Client.SystemWebViewOptions.HtmlMessageSuccess"/></remarks> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.BrowserRedirectError"> <summary> When the user finishes authenticating, but an error occurred, MSAL will redirect the browser to the given Uri </summary> <remarks>Takes precedence over <see cref="P:Microsoft.Identity.Client.SystemWebViewOptions.HtmlMessageError"/></remarks> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.iOSHidePrivacyPrompt"> <summary> This hides the privacy prompt displayed on iOS Devices (ver 13.0+) when set to true. By default, it is false and displays the prompt. </summary> </member> <member name="P:Microsoft.Identity.Client.SystemWebViewOptions.OpenBrowserAsync"> <summary> Allows developers to implement their own logic for starting a browser and navigating to a specific Uri. MSAL will use this when opening the browser. Leave it null and the user configured browser will be used. Consider using the static helpers OpenWithEdgeBrowserAsync and OpenWithChromeEdgeBrowserAsync </summary> </member> <member name="M:Microsoft.Identity.Client.SystemWebViewOptions.OpenWithEdgeBrowserAsync(System.Uri)"> <summary> Use Microsoft Edge to navigate to the given URI. On non-windows platforms it uses whatever browser is the default. </summary> </member> <member name="M:Microsoft.Identity.Client.SystemWebViewOptions.OpenWithChromeEdgeBrowserAsync(System.Uri)"> <summary> Use Microsoft Edge Chromium to navigate to the given URI. Requires the browser to be installed. On Linux, uses the default system browser instead, as Edge is not available. </summary> </member> <member name="T:Microsoft.Identity.Client.WindowsBrokerOptions"> <summary> Advanced options for using the Windows 10 broker. For more details see https://aka.ms/msal-net-wam </summary> </member> <member name="M:Microsoft.Identity.Client.WindowsBrokerOptions.#ctor"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.WindowsBrokerOptions.MsaPassthrough"> <summary> A legacy option available only to Microsoft applications. Should be avoided where possible. Support is experimental. </summary> </member> <member name="P:Microsoft.Identity.Client.WindowsBrokerOptions.ListWindowsWorkAndSchoolAccounts"> <summary> Allow the Windows broker to list Work and School accounts as part of the <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync"/> </summary> <remarks>On UWP, accounts are not listed due to privacy concerns</remarks> </member> <member name="P:Microsoft.Identity.Client.WindowsBrokerOptions.HeaderText"> <summary> Display a custom text in the broker UI controls which support it. </summary> <remarks> Currently only the WAM account picker allows for this customization, see <see href="https://docs.microsoft.com/en-us/windows/uwp/security/web-account-manager#add-a-custom-header">WAM documentation</see>. </remarks> </member> <member name="T:Microsoft.Identity.Client.AadAuthorityAudience"> <summary> Specifies which Microsoft accounts can be used for sign-in with a given application. See https://aka.ms/msal-net-application-configuration </summary> </member> <member name="F:Microsoft.Identity.Client.AadAuthorityAudience.None"> <summary> The sign-in audience was not specified </summary> </member> <member name="F:Microsoft.Identity.Client.AadAuthorityAudience.AzureAdMyOrg"> <summary> Users with a Microsoft work or school account in my organization’s Azure AD tenant (i.e. single tenant). Maps to https://[instance]/[tenantId] </summary> </member> <member name="F:Microsoft.Identity.Client.AadAuthorityAudience.AzureAdAndPersonalMicrosoftAccount"> <summary> Users with a personal Microsoft account, or a work or school account in any organization’s Azure AD tenant Maps to https://[instance]/common/ </summary> </member> <member name="F:Microsoft.Identity.Client.AadAuthorityAudience.AzureAdMultipleOrgs"> <summary> Users with a Microsoft work or school account in any organization’s Azure AD tenant (i.e. multi-tenant). Maps to https://[instance]/organizations/ </summary> </member> <member name="F:Microsoft.Identity.Client.AadAuthorityAudience.PersonalMicrosoftAccount"> <summary> Users with a personal Microsoft account. Maps to https://[instance]/consumers/ </summary> </member> <member name="T:Microsoft.Identity.Client.AbstractApplicationBuilder`1"> <summary> </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDicoveryMetadata(System.String)"> <summary> Allows developers to configure their own valid authorities. A json string similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: <list type="bullet"> <item><description>Call REST APIs on the environment specified in the preferred_network</description></item> <item><description>Identify an environment under which to save tokens and accounts in the cache</description></item> <item><description>Use the environment aliases to match tokens issued to other authorities</description></item> </list> For more details see https://aka.ms/msal-net-custom-instance-metadata </summary> <remarks> Developers take responsibility for authority validation if they use this method. Should not be used when the authority is not know in advance. Has no effect on ADFS or B2C authorities, only for AAD authorities</remarks> <param name="instanceDiscoveryJson"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDiscoveryMetadata(System.String)"> <summary> Allows developers to configure their own valid authorities. A json string similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: <list type="bullet"> <item><description>Call REST APIs on the environment specified in the preferred_network</description></item> <item><description>Identify an environment under which to save tokens and accounts in the cache</description></item> <item><description>Use the environment aliases to match tokens issued to other authorities</description></item> </list> For more details see https://aka.ms/msal-net-custom-instance-metadata </summary> <remarks> Developers take responsibility for authority validation if they use this method. Should not be used when the authority is not known in advance. Has no effect on ADFS or B2C authorities, only for AAD authorities</remarks> <param name="instanceDiscoveryJson"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDicoveryMetadata(System.Uri)"> <summary> Lets an organization setup their own service to handle instance discovery, which enables better caching for microservice/service environments. A Uri that returns a response similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: <list type="bullet"> <item><description>Call REST APIs on the environment specified in the preferred_network</description></item> <item><description>Identify an environment under which to save tokens and accounts in the cache</description></item> <item><description>Use the environment aliases to match tokens issued to other authorities</description></item> </list> For more details see https://aka.ms/msal-net-custom-instance-metadata </summary> <remarks> Developers take responsibility for authority validation if they use this method. Should not be used when the authority is not know in advance. Has no effect on ADFS or B2C authorities, only for AAD authorities</remarks> <param name="instanceDiscoveryUri"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDiscoveryMetadata(System.Uri)"> <summary> Lets an organization setup their own service to handle instance discovery, which enables better caching for microservice/service environments. A Uri that returns a response similar to https://aka.ms/aad-instance-discovery should be provided. MSAL uses this information to: <list type="bullet"> <item><description>Call REST APIs on the environment specified in the preferred_network</description></item> <item><description>Identify an environment under which to save tokens and accounts in the cache</description></item> <item><description>Use the environment aliases to match tokens issued to other authorities</description></item> </list> For more details see https://aka.ms/msal-net-custom-instance-metadata </summary> <remarks> Developers take responsibility for authority validation if they use this method. Should not be used when the authority is not known in advance. Has no effect on ADFS or B2C authorities, only for AAD authorities</remarks> <param name="instanceDiscoveryUri"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithCacheOptions(Microsoft.Identity.Client.CacheOptions)"> <summary> Options for MSAL token caches. MSAL maintains a token cache internally in memory. By default, this cache object is part of each instance of <see cref="T:Microsoft.Identity.Client.PublicClientApplication"/> or <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>. This method allows customization of the in-memory token cache of MSAL. MSAL's memory cache is different than token cache serialization. Cache serialization pulls the tokens from a cache (e.g. Redis, Cosmos, or a file on disk), where they are stored in JSON format, into MSAL's internal memory cache. Memory cache operations do not involve JSON operations. External cache serialization remains the recommended way to handle desktop apps, web site and web APIs, as it provides persistence. These options do not currently control external cache serialization. Detailed guidance for each application type and platform: https://aka.ms/msal-net-token-cache-serialization </summary> <param name="options">Options for the internal MSAL token caches. </param> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithLegacyCacheCompatibility(System.Boolean)"> <summary> Enables legacy ADAL cache serialization and deserialization. </summary> <param name="enableLegacyCacheCompatibility">Enable legacy ADAL cache compatibility.</param> <returns>The builder to chain the .With methods.</returns> <remarks> ADAL is a previous legacy generation of MSAL.NET authentication library. If you don't use <c>.WithLegacyCacheCompatibility(false)</c>, then by default, the ADAL cache is used (along with MSAL cache). <c>true</c> flag is only needed for specific migration scenarios from ADAL.NET to MSAL.NET when both library versions are running side-by-side. To improve performance add <c>.WithLegacyCacheCompatibility(false)</c> unless you care about migration scenarios. </remarks> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithTelemetry(Microsoft.Identity.Client.TelemetryCallback)"> <summary> Sets the telemetry callback. For details see https://aka.ms/msal-net-telemetry </summary> <param name="telemetryCallback">Delegate to the callback sending the telemetry elaborated by the library to the telemetry endpoint of choice</param> <returns>The builder to chain the .With methods</returns> <exception cref="T:System.InvalidOperationException"/> is thrown if the method was already called on the application builder. </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithClientId(System.String)"> <summary> Sets the Client ID of the application </summary> <param name="clientId">Client ID (also known as <i>Application ID</i>) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithRedirectUri(System.String)"> <summary> Sets the redirect URI of the application. The URI must also be registered in the application portal. See https://aka.ms/msal-net-application-configuration </summary> <param name="redirectUri">URL where the STS will call back the application with the security token. Public Client Applications - desktop, mobile, console apps - use different browsers (system browser, embedded browses) and brokers and each has its own rules. </param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithTenantId(System.String)"> <summary> Sets the Tenant Id of the organization from which the application will let users sign-in. This is classically a GUID or a domain name. See https://aka.ms/msal-net-application-configuration. Although it is also possible to set <paramref name="tenantId"/> to <c>common</c>, <c>organizations</c>, and <c>consumers</c>, it's recommended to use one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"/> </summary> <param name="tenantId">tenant ID of the Azure AD tenant or a domain associated with this Azure AD tenant, in order to sign-in a user of a specific organization only</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithClientName(System.String)"> <summary> Sets the name of the calling application for telemetry purposes. </summary> <param name="clientName">The name of the application for telemetry purposes.</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithClientVersion(System.String)"> <summary> Sets the version of the calling application for telemetry purposes. </summary> <param name="clientVersion">The version of the calling application for telemetry purposes.</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithOptions(Microsoft.Identity.Client.ApplicationOptions)"> <summary> Sets application options, which can, for instance have been read from configuration files. See https://aka.ms/msal-net-application-configuration. </summary> <param name="applicationOptions">Application options</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithExtraQueryParameters(System.Collections.Generic.IDictionary{System.String,System.String})"> <summary> Sets Extra Query Parameters for the query string in the HTTP authentication request </summary> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority as a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithExtraQueryParameters(System.String)"> <summary> Sets Extra Query Parameters for the query string in the HTTP authentication request </summary> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The string needs to be properly URL-encoded and ready to send as a string of segments of the form <c>key=value</c> separated by an ampersand character. </param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithClientCapabilities(System.Collections.Generic.IEnumerable{System.String})"> <summary> 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" </summary> <remarks> MSAL will transform these into special claims request. See https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter for details on claim requests. For more details see https://aka.ms/msal-net-claims-request </remarks> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDiscovery(System.Boolean)"> <summary> Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to false will completely disable instance discovery and authority validation. This will not affect the behavior of application configured with regional endpoints however. </summary> <remarks>If instance discovery is disabled and no user metadata is provided, MSAL will use the provided authority without any checks. <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDiscoveryMetadata(System.String)"/> takes priority over <paramref name="enableInstanceDiscovery"/> so instance metadata can be provided regardless of this configuration. </remarks> <param name="enableInstanceDiscovery">Determines if instance discovery/Authority validation is performed</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithTelemetry(Microsoft.Identity.Client.ITelemetryConfig)"> <summary> Generate telemetry aggregation events. </summary> <param name="telemetryConfig"></param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(System.Uri,System.Boolean)"> <summary> Adds a known authority to the application from its Uri. See https://aka.ms/msal-net-application-configuration. This constructor is mainly used for scenarios where the authority is not a standard Azure AD authority, nor an ADFS authority, nor an Azure AD B2C authority. For Azure AD, even in sovereign clouds, prefer using other overrides such as <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"/> </summary> <param name="authorityUri">Uri of the authority</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(System.String,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users specifying the full authority Uri. See https://aka.ms/msal-net-application-configuration. </summary> <param name="authorityUri">URL of the security token service (STS) from which MSAL.NET will acquire the tokens. Usual authorities endpoints for the Azure public Cloud are: <list type="bullet"> <item><description><c>https://login.microsoftonline.com/tenant/</c> where <c>tenant</c> is the tenant ID of the Azure AD tenant or a domain associated with this Azure AD tenant, in order to sign-in users of a specific organization only</description></item> <item><description><c>https://login.microsoftonline.com/common/</c> to sign-in users with any work and school accounts or Microsoft personal account</description></item> <item><description><c>https://login.microsoftonline.com/organizations/</c> to sign-in users with any work and school accounts</description></item> <item><description><c>https://login.microsoftonline.com/consumers/</c> to sign-in users with only personal Microsoft accounts (live)</description></item> </list> Note that this setting needs to be consistent with what is declared in the application registration portal</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(System.String,System.Guid,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) specified by its tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="cloudInstanceUri">Azure Cloud instance.</param> <param name="tenantId">GUID of the tenant from which to sign-in users.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(System.String,System.String,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its domain name. See https://aka.ms/msal-net-application-configuration. </summary> <param name="cloudInstanceUri">Uri to the Azure Cloud instance (for instance <c>https://login.microsoftonline.com)</c></param> <param name="tenant">domain name associated with the tenant from which to sign-in users</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <remarks> <paramref name="tenant"/> can also contain the string representation of a GUID (tenantId), or even <c>common</c>, <c>organizations</c> or <c>consumers</c> but in this case it's recommended to use another override (<see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.Guid,System.Boolean)"/> and <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"/> </remarks> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.Guid,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its cloud instance and its tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...)</param> <param name="tenantId">Tenant Id of the tenant from which to sign-in users</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,System.String,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users from a single organization (single tenant application) described by its cloud instance and its domain name or tenant ID. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...).</param> <param name="tenant">Domain name associated with the Azure AD tenant from which to sign-in users. This can also be a GUID.</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods.</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AzureCloudInstance,Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users specifying the cloud instance and the sign-in audience. See https://aka.ms/msal-net-application-configuration. </summary> <param name="azureCloudInstance">Instance of Azure Cloud (for instance Azure worldwide cloud, Azure German Cloud, US government ...)</param> <param name="authorityAudience">Sign-in audience (one AAD organization, any work and school accounts, or any work and school accounts and Microsoft personal accounts</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAuthority(Microsoft.Identity.Client.AadAuthorityAudience,System.Boolean)"> <summary> Adds a known Azure AD authority to the application to sign-in users specifying the sign-in audience (the cloud being the Azure public cloud). See https://aka.ms/msal-net-application-configuration. </summary> <param name="authorityAudience">Sign-in audience (one AAD organization, any work and school accounts, or any work and school accounts and Microsoft personal accounts</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithAdfsAuthority(System.String,System.Boolean)"> <summary> Adds a known Authority corresponding to an ADFS server. See https://aka.ms/msal-net-adfs </summary> <param name="authorityUri">Authority URL for an ADFS server</param> <param name="validateAuthority">Whether the authority should be validated against the server metadata.</param> <remarks>MSAL.NET will only support ADFS 2019 or later.</remarks> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithB2CAuthority(System.String)"> <summary> Adds a known authority corresponding to an Azure AD B2C policy. See https://aka.ms/msal-net-b2c-specificities </summary> <param name="authorityUri">Azure AD B2C authority, including the B2C policy (for instance <c>"https://fabrikamb2c.b2clogin.com/tfp/{Tenant}/{policy}</c></param>) <returns>The builder to chain the .With methods</returns> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.KerberosServicePrincipalName"> <summary> Service principal name for Kerberos Service Ticket. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.TicketContainer"> <summary> Kerberos Service Ticket container to be used. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.ClientSecret"> <summary> This is here just to support the public IAppConfig. Should not be used internally, instead use the <see cref="P:Microsoft.Identity.Client.ApplicationConfiguration.ClientCredential" /> abstraction. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.ClientCredentialCertificate"> <summary> This is here just to support the public IAppConfig. Should not be used internally, instead use the <see cref="P:Microsoft.Identity.Client.ApplicationConfiguration.ClientCredential" /> abstraction. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.AadAuthorityAudience"> <summary> Should _not_ go in the interface, only for builder usage while determining authorities with ApplicationOptions </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.AzureCloudInstance"> <summary> Should _not_ go in the interface, only for builder usage while determining authorities with ApplicationOptions </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.Instance"> <summary> Should _not_ go in the interface, only for builder usage while determining authorities with ApplicationOptions </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationConfiguration.ValidateAuthority"> <summary> Should _not_ go in the interface, only for builder usage while determining authorities with ApplicationOptions </summary> </member> <member name="T:Microsoft.Identity.Client.ApplicationOptions"> <summary> 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 <see cref="T:Microsoft.Identity.Client.PublicClientApplicationOptions"/> and <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplicationOptions"/> </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.ClientId"> <summary> Client ID (also known as App ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app) </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.TenantId"> <summary> 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 <see cref="P:Microsoft.Identity.Client.ApplicationOptions.AadAuthorityAudience"/>. If both are provided, an exception will be thrown. </summary> <remarks>The name of the property was chosen to ensure compatibility with AzureAdOptions in ASP.NET Core configuration files (even the semantics would be tenant)</remarks> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.AadAuthorityAudience"> <summary> Sign-in audience. This property is mutually exclusive with TenantId. If both are provided, an exception will be thrown. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.Instance"> <summary> 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 <see cref="P:Microsoft.Identity.Client.ApplicationOptions.AzureCloudInstance"/>. If both are provided, an exception will be thrown. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.AzureCloudInstance"> <summary> 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 <see cref="P:Microsoft.Identity.Client.ApplicationOptions.Instance"/>. If both are provided, an exception will be thrown. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.RedirectUri"> <summary> 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: <see cref="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.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, <c>baseUrl//signin-oidc</c> for ASP.NET Core web apps). For daemon applications (confidential client applications using only the Client Credential flow that is calling <c>AcquireTokenForClient</c>), no reply URI is needed. </summary> <remarks>This is especially important when you deploy an application that you have initially tested locally; you then need to add the reply URL of the deployed application in the application registration portal </remarks> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.Component"> <summary> Identifier of the component (libraries/SDK) consuming MSAL.NET. This will allow for disambiguation between MSAL usage by the app vs MSAL usage by component libraries. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.ClientName"> <summary> The name of the calling application for telemetry purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.ClientVersion"> <summary> The version of the calling application for telemetry purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.ClientCapabilities"> <summary> 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" </summary> <remarks> MSAL will transform these into special claims request. See https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter for details on claim requests. For more details see https://aka.ms/msal-net-claims-request </remarks> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.LegacyCacheCompatibilityEnabled"> <summary> Enables legacy ADAL cache serialization and deserialization. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.KerberosServicePrincipalName"> <summary> Service principal name for Kerberos Service Ticket. </summary> </member> <member name="P:Microsoft.Identity.Client.ApplicationOptions.TicketContainer"> <summary> Kerberos Service Ticket container to be used. </summary> </member> <member name="T:Microsoft.Identity.Client.AssertionRequestOptions"> <summary> Information about the client assertion that need to be generated See https://aka.ms/msal-net-client-assertion </summary> <remarks> Use the provided information to generate the client assertion payload </remarks> </member> <member name="P:Microsoft.Identity.Client.AssertionRequestOptions.CancellationToken"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.AssertionRequestOptions.ClientID"> <summary> Client ID for which a signed assertion is requested </summary> </member> <member name="P:Microsoft.Identity.Client.AssertionRequestOptions.TokenEndpoint"> <summary> The intended token endpoint </summary> </member> <member name="T:Microsoft.Identity.Client.AuthorityInfo"> <remarks> This class must be kept immutable </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthorityInfo.IsUserAssertionSupported"> <summary> For IWA </summary> </member> <member name="P:Microsoft.Identity.Client.AuthorityInfo.CanBeTenanted"> <summary> Authority support multi-tenantcy. ADFS and Generic authorities are not tenanted. B2C doesn't allow multi-tenancy scenarios, but the authority itself is tenanted. For CIAM, we allow multi-tenancy scenarios, and expect the STS to fail. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthorityInfo.AuthorityInfoHelper"> <summary> This is extension for AuthorityInfo </summary> </member> <member name="M:Microsoft.Identity.Client.AuthorityInfo.AuthorityInfoHelper.CreateAuthorityForRequestAsync(Microsoft.Identity.Client.Internal.RequestContext,Microsoft.Identity.Client.AuthorityInfo,Microsoft.Identity.Client.IAccount)"> <summary> Figures out the authority based on the authority from the config and the authority from the request, and optionally the homeAccountTenantId, which has an impact on AcquireTokenSilent If the request authority is consumers, organizations, or common, it should just be set an the app level. The algorithm is: 1. If there is no request authority (i.e. no authority override), use the config authority. 1.1. For AAD, if the config authority is "common" etc, try to use the tenanted version with the home account tenant ID 2. If there is a request authority, try to use it. 2.1. If the request authority is not "common", then use it 2.2 If the request authority is "common", ignore it, and use 1.1 Special cases: - if the authority is not defined at the application level and the request level is not AAD, use the request authority - if the authority is defined at app level, and the request level authority is of different type, throw an exception - if the intended authority is consumers, please define it at the app level and not at the request level. known issue: https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/issues/2929 </summary> </member> <member name="T:Microsoft.Identity.Client.AuthorityType"> <summary> Enumeration for the AuthorityTypes </summary> </member> <member name="T:Microsoft.Identity.Client.AzureCloudInstance"> <summary> </summary> </member> <member name="F:Microsoft.Identity.Client.AzureCloudInstance.None"> <summary> Value communicating that the AzureCloudInstance is not specified. </summary> </member> <member name="F:Microsoft.Identity.Client.AzureCloudInstance.AzurePublic"> <summary> Microsoft Azure public cloud. Maps to https://login.microsoftonline.com </summary> </member> <member name="F:Microsoft.Identity.Client.AzureCloudInstance.AzureChina"> <summary> Microsoft Azure China cloud. Maps to https://login.chinacloudapi.cn </summary> </member> <member name="F:Microsoft.Identity.Client.AzureCloudInstance.AzureGermany"> <summary> Microsoft Azure German cloud ("Black Forest"). Maps to https://login.microsoftonline.de </summary> </member> <member name="F:Microsoft.Identity.Client.AzureCloudInstance.AzureUsGovernment"> <summary> US Government cloud. Maps to https://login.microsoftonline.us </summary> </member> <member name="T:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1"> <summary> </summary> <typeparam name="T"></typeparam> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithHttpClientFactory(Microsoft.Identity.Client.IMsalHttpClientFactory)"> <summary> Uses a specific <see cref="T:Microsoft.Identity.Client.IMsalHttpClientFactory"/> to communicate with the IdP. This enables advanced scenarios such as setting a proxy, or setting the Agent. </summary> <param name="httpClientFactory">HTTP client factory</param> <remarks>MSAL does not guarantee that it will not modify the HttpClient, for example by adding new headers. Prior to the changes needed in order to make MSAL's httpClients thread safe (https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/pull/2046/files), the httpClient had the possibility of throwing an exception stating "Properties can only be modified before sending the first request". MSAL's httpClient will no longer throw this exception after 4.19.0 (https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/releases/tag/4.19.0) see (https://aka.ms/msal-httpclient-info) for more information. </remarks> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithHttpClientFactory(Microsoft.Identity.Client.IMsalHttpClientFactory,System.Boolean)"> <summary> Uses a specific <see cref="T:Microsoft.Identity.Client.IMsalHttpClientFactory"/> to communicate with the IdP. This enables advanced scenarios such as setting a proxy, or setting the Agent. </summary> <param name="httpClientFactory">HTTP client factory</param> <param name="retryOnceOn5xx">Configures MSAL to retry on 5xx server errors. When enabled (on by default), MSAL will wait 1 second after recieving a 5xx error and then retry the http request again.</param> <remarks>MSAL does not guarantee that it will not modify the HttpClient, for example by adding new headers. Prior to the changes needed in order to make MSAL's httpClients thread safe (https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/pull/2046/files), the httpClient had the possibility of throwing an exception stating "Properties can only be modified before sending the first request". MSAL's httpClient will no longer throw this exception after 4.19.0 (https://github.com/AzureAD/microsoft-authentication-library-for-dotnet/releases/tag/4.19.0) see (https://aka.ms/msal-httpclient-info) for more information. If you only want to configure the retryOnceOn5xx parameter, set httpClientFactory to null and MSAL will use the default http client. </remarks> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"> <summary> Sets the logging callback. For details see https://aka.ms/msal-net-logging </summary> <param name="loggingCallback"></param> <param name="logLevel">Desired level of logging. The default is LogLevel.Info</param> <param name="enablePiiLogging">Boolean used 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 <c>false</c>, which ensures that your application is compliant with GDPR. You can set it to <c>true</c> for advanced debugging requiring PII If both WithLogging apis are set, the other one will overide the this one </param> <param name="enableDefaultPlatformLogging">Flag to enable/disable logging to platform defaults. In Desktop/UWP, Event Tracing is used. In iOS, NSLog is used. In android, Logcat is used. The default value is <c>false</c> </param> <returns>The builder to chain the .With methods</returns> <exception cref="T:System.InvalidOperationException"/> is thrown if the loggingCallback was already set on the application builder </member> <member name="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithLogging(Microsoft.IdentityModel.Abstractions.IIdentityLogger,System.Boolean)"> <summary> Sets the Identity Logger. For details see https://aka.ms/msal-net-logging </summary> <param name="identityLogger">IdentityLogger</param> <param name="enablePiiLogging">Boolean used 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 <c>false</c>, which ensures that your application is compliant with GDPR. You can set it to <c>true</c> for advanced debugging requiring PII If both WithLogging apis are set, this one will override the other </param> <returns>The builder to chain the .With methods</returns> <remarks>This is an experimental API. The method signature may change in the future without involving a major version upgrade.</remarks> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithDebugLoggingCallback(Microsoft.Identity.Client.LogLevel,System.Boolean,System.Boolean)"> <summary> Sets the Debug logging callback to a default debug method which displays the level of the message and the message itself. For details see https://aka.ms/msal-net-logging </summary> <param name="logLevel">Desired level of logging. The default is LogLevel.Info</param> <param name="enablePiiLogging">Boolean used 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 <c>false</c>, which ensures that your application is compliant with GDPR. You can set it to <c>true</c> for advanced debugging requiring PII </param> <param name="withDefaultPlatformLoggingEnabled">Flag to enable/disable logging to platform defaults. In Desktop/UWP, Event Tracing is used. In iOS, NSLog is used. In android, logcat is used. The default value is <c>false</c> </param> <returns>The builder to chain the .With methods</returns> <exception cref="T:System.InvalidOperationException"/> is thrown if the loggingCallback was already set on the application builder by calling <see cref="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"/> <seealso cref="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"/> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithOptions(Microsoft.Identity.Client.BaseApplicationOptions)"> <summary> Sets application options, which can, for instance have been read from configuration files. See https://aka.ms/msal-net-application-configuration. </summary> <param name="applicationOptions">Application options</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithExperimentalFeatures(System.Boolean)"> <summary> Allows usage of experimental features and APIs. If this flag is not set, experimental features will throw an exception. For details see https://aka.ms/msal-net-experimental-features </summary> <remarks> Changes in the public API of experimental features will not result in an increment of the major version of this library. For these reason we advise against using these features in production. </remarks> </member> <member name="T:Microsoft.Identity.Client.BaseApplicationOptions"> <summary> 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 <see cref="T:Microsoft.Identity.Client.ApplicationOptions"/> </summary> </member> <member name="P:Microsoft.Identity.Client.BaseApplicationOptions.LogLevel"> <summary> Enables you to configure the level of logging you want. The default value is <see cref="F:Microsoft.Identity.Client.LogLevel.Info"/>. Setting it to <see cref="F:Microsoft.Identity.Client.LogLevel.Error"/> will only get errors Setting it to <see cref="F:Microsoft.Identity.Client.LogLevel.Warning"/> will get errors and warning, etc.. See https://aka.ms/msal-net-logging </summary> </member> <member name="P:Microsoft.Identity.Client.BaseApplicationOptions.EnablePiiLogging"> <summary> 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 <c>false</c>, which ensures that your application is compliant with GDPR. You can set it to <c>true</c> for advanced debugging requiring PII. See https://aka.ms/msal-net-logging </summary> <seealso cref="P:Microsoft.Identity.Client.BaseApplicationOptions.IsDefaultPlatformLoggingEnabled"/> </member> <member name="P:Microsoft.Identity.Client.BaseApplicationOptions.IsDefaultPlatformLoggingEnabled"> <summary> Flag to enable/disable logging to platform defaults. In Desktop/UWP, Event Tracing is used. In iOS, NSLog is used. In Android, logcat is used. The default value is <c>false</c>. See https://aka.ms/msal-net-logging </summary> <seealso cref="P:Microsoft.Identity.Client.BaseApplicationOptions.EnablePiiLogging"/> </member> <member name="T:Microsoft.Identity.Client.CacheOptions"> <summary> Options for MSAL token caches. </summary> <remarks> Detailed cache guidance for each application type and platform, including L2 options: https://aka.ms/msal-net-token-cache-serialization </remarks> </member> <member name="P:Microsoft.Identity.Client.CacheOptions.EnableSharedCacheOptions"> <summary> Recommended options for using a static cache. </summary> </member> <member name="M:Microsoft.Identity.Client.CacheOptions.#ctor"> <summary> Constructor for the options with default values. </summary> </member> <member name="M:Microsoft.Identity.Client.CacheOptions.#ctor(System.Boolean)"> <summary> Constructor </summary> <param name="useSharedCache">Set to true to share the cache between all ClientApplication objects. The cache becomes static. <see cref="P:Microsoft.Identity.Client.CacheOptions.UseSharedCache"/> for a detailed description. </param> </member> <member name="P:Microsoft.Identity.Client.CacheOptions.UseSharedCache"> <summary> Share the cache between all ClientApplication objects. The cache becomes static. Defaults to false. </summary> <remarks> Recommended only for client credentials flow (service to service communication). Web apps and Web APIs should use external token caching (Redis, Cosmos etc.) for scaling purposes. Desktop apps should encrypt and persist their token cache to disk, to avoid losing tokens when app restarts. ADAL used a static cache by default. </remarks> </member> <member name="T:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.#ctor(Microsoft.Identity.Client.ApplicationConfiguration)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.CreateWithApplicationOptions(Microsoft.Identity.Client.ConfidentialClientApplicationOptions)"> <summary> Constructor of a ConfidentialClientApplicationBuilder from application configuration options. See https://aka.ms/msal-net-application-configuration </summary> <param name="options">Confidential client applications configuration options</param> <returns>A <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder"/> from which to set more parameters, and to create a confidential client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.Create(System.String)"> <summary> Creates a ConfidentialClientApplicationBuilder from a clientID. See https://aka.ms/msal-net-application-configuration </summary> <param name="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)/.</param> <returns>A <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder"/> from which to set more parameters, and to create a confidential client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary> Sets the certificate associated with the application. </summary> <param name="certificate">The X509 certificate used as credentials to prove the identity of the application to Azure AD.</param> <remarks> You should use certificates with a private key size of at least 2048 bytes. Future versions of this library might reject certificates with smaller keys. Does not send the certificate (as x5c parameter) with the request by default. </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Boolean)"> <summary> Sets the certificate associated with the application. Applicable to first-party applications only, this method also allows to specify if the <see href="https://datatracker.ietf.org/doc/html/rfc7517#section-4.7">x5c claim</see> should be sent to Azure AD. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the certificate chain to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni </summary> <param name="certificate">The X509 certificate used as credentials to prove the identity of the application to Azure AD.</param> <param name="sendX5C">To send X5C with every request or not. The default is <c>false</c></param> <remarks>You should use certificates with a private key size of at least 2048 bytes. Future versions of this library might reject certificates with smaller keys. </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientClaims(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Collections.Generic.IDictionary{System.String,System.String},System.Boolean)"> <summary> Sets the certificate associated with the application along with the specific claims to sign. By default, this will merge the <paramref name="claimsToSign"/> with the default required set of claims needed for authentication. If <paramref name="mergeWithDefaultClaims"/> is set to false, you will need to provide the required default claims. See https://aka.ms/msal-net-client-assertion </summary> <param name="certificate">The X509 certificate used as credentials to prove the identity of the application to Azure AD.</param> <param name="claimsToSign">The claims to be signed by the provided certificate.</param> <param name="mergeWithDefaultClaims">Determines whether or not to merge <paramref name="claimsToSign"/> with the default claims required for authentication.</param> <remarks> You should use certificates with a private key size of at least 2048 bytes. Future versions of this library might reject certificates with smaller keys. Does not send the certificate (as x5c parameter) with the request by default. </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientClaims(System.Security.Cryptography.X509Certificates.X509Certificate2,System.Collections.Generic.IDictionary{System.String,System.String},System.Boolean,System.Boolean)"> <summary> Sets the certificate associated with the application along with the specific claims to sign. By default, this will merge the <paramref name="claimsToSign"/> with the default required set of claims needed for authentication. If <paramref name="mergeWithDefaultClaims"/> is set to false, you will need to provide the required default claims. See https://aka.ms/msal-net-client-assertion </summary> <param name="certificate">The X509 certificate used as credentials to prove the identity of the application to Azure AD.</param> <param name="claimsToSign">The claims to be signed by the provided certificate.</param> <param name="mergeWithDefaultClaims">Determines whether or not to merge <paramref name="claimsToSign"/> with the default claims required for authentication.</param> <param name="sendX5C">To send X5C with every request or not.</param> <remarks>You should use certificates with a private key size of at least 2048 bytes. Future versions of this library might reject certificates with smaller keys.</remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientSecret(System.String)"> <summary> Sets the application secret </summary> <param name="clientSecret">Secret string previously shared with AAD at application registration to prove the identity of the application (the client) requesting the tokens</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientAssertion(System.String)"> <summary> Sets the application client assertion. See https://aka.ms/msal-net-client-assertion. This will create an assertion that will be held within the client application's memory for the duration of the client. You can use <see cref="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientAssertion(System.Func{System.String})"/> to set a delegate that will be executed for each authentication request. This will allow you to update the client assertion used by the client application once the assertion expires. </summary> <param name="signedClientAssertion">The client assertion used to prove the identity of the application to Azure AD. This is a Base-64 encoded JWT.</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientAssertion(System.Func{System.String})"> <summary> Configures a delegate that creates a client assertion. See https://aka.ms/msal-net-client-assertion </summary> <param name="clientAssertionDelegate">delegate computing the client assertion used to prove the identity of the application to Azure AD. This is a delegate that computes a Base-64 encoded JWT for each authentication call.</param> <returns>The ConfidentialClientApplicationBuilder to chain more .With methods</returns> <remarks> Callers can use this mechanism to cache their assertions </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientAssertion(System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{System.String}})"> <summary> Configures an async delegate that creates a client assertion. See https://aka.ms/msal-net-client-assertion </summary> <param name="clientAssertionAsyncDelegate">An async delegate computing the client assertion used to prove the identity of the application to Azure AD. This is a delegate that computes a Base-64 encoded JWT for each authentication call.</param> <returns>The ConfidentialClientApplicationBuilder to chain more .With methods</returns> <remarks> Callers can use this mechanism to cache their assertions </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithClientAssertion(System.Func{Microsoft.Identity.Client.AssertionRequestOptions,System.Threading.Tasks.Task{System.String}})"> <summary> Configures an async delegate that creates a client assertion. See https://aka.ms/msal-net-client-assertion </summary> <param name="clientAssertionAsyncDelegate">An async delegate computing the client assertion used to prove the identity of the application to Azure AD. This is a delegate that computes a Base-64 encoded JWT for each authentication call.</param> <returns>The ConfidentialClientApplicationBuilder to chain more .With methods</returns> <remarks> Callers can use this mechanism to cache their assertions </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithAzureRegion(System.String)"> <summary> Instructs MSAL to use an Azure regional token service. This feature is currently available to first-party applications only. </summary> <param name="azureRegion">Either the string with the region (preferred) or use <see cref="F:Microsoft.Identity.Client.ConfidentialClientApplication.AttemptRegionDiscovery"/> and MSAL will attempt to auto-detect the region. </param> <remarks> The region value should be a short region name for the region where the service is deployed. For example, "centralus" is short name for region Central US. Currently only tokens for the client credential flow can be obtained from the regional service. Requires configuration at the tenant level. Auto-detection works on a limited number of Azure artifacts (VMs, Azure functions). If auto-detection fails, the non-regional endpoint will be used. If a specific region was provided and the token web request failed, verify that the region name is valid. See https://aka.ms/msal-net-region-discovery for more details. </remarks> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithCacheSynchronization(System.Boolean)"> <summary> When set to <c>true</c>, MSAL will lock cache access at the <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> level, i.e. the block of code between BeforeAccessAsync and AfterAccessAsync callbacks will be synchronized. Apps can set this flag to <c>false</c> to enable an optimistic cache locking strategy, which may result in better performance at the cost of cache consistency. Setting this flag to <c>false</c> is only recommended for apps which create a new <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> per request. </summary> <remarks> This flag is <c>true</c> by default. The default behavior is recommended. </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithGenericAuthority(System.String)"> <summary> Adds a known authority corresponding to a generic OpenIdConnect Identity Provider. MSAL will append ".well-known/openid-configuration" to the authority and retrieve the OIDC metadata from there, to figure out the endpoints. See https://openid.net/specs/openid-connect-core-1_0.html#Terminology </summary> <param name="authorityUri">OpenIdConnect authority</param> <returns>The builder to chain the .With methods</returns> <remarks>This is an experimental API and only AcquireTokenForClient (client_credentials flow) has been implemented</remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.WithTelemetryClient(Microsoft.IdentityModel.Abstractions.ITelemetryClient[])"> <summary> Sets telemetry client for the application. </summary> <param name="telemetryClients">List of telemetry clients to add telemetry logs.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.Validate"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.Build"> <summary> Builds the ConfidentialClientApplication from the parameters set in the builder </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder.BuildConcrete"> <summary> </summary> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.ConfidentialClientApplicationOptions"> <summary> Configuration options for a confidential client application (web app / web API / daemon app). See https://aka.ms/msal-net/application-configuration </summary> </member> <member name="P:Microsoft.Identity.Client.ConfidentialClientApplicationOptions.ClientSecret"> <summary> Client secret for the confidential client application. This secret (application password) is provided by the application registration portal, or provided to Azure AD during the application registration with PowerShell AzureAD, PowerShell AzureRM, or Azure CLI. </summary> </member> <member name="P:Microsoft.Identity.Client.ConfidentialClientApplicationOptions.AzureRegion"> <summary> Instructs MSAL.NET to use an Azure regional token service. This setting should be set to either the string with the region (preferred) or to "TryAutoDetect" and MSAL.NET will attempt to auto-detect the region. </summary> <remarks> Region names as per https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.management.resourcemanager.fluent.core.region?view=azure-dotnet. Not all auth flows can use the regional token service. Service To Service (client credential flow) tokens can be obtained from the regional service. Requires configuration at the tenant level. Auto-detection works on a limited number of Azure artifacts (VMs, Azure functions). If auto-detection fails, the non-regional endpoint will be used. If an invalid region name is provided, the non-regional endpoint MIGHT be used or the token request MIGHT fail. See https://aka.ms/msal-net-region-discovery for more details. </remarks> </member> <member name="P:Microsoft.Identity.Client.ConfidentialClientApplicationOptions.EnableCacheSynchronization"> <summary> When set to <c>true</c>, MSAL will lock cache access at the <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> level, i.e. the block of code between BeforeAccessAsync and AfterAccessAsync callbacks will be synchronized. Apps can set this flag to <c>false</c> to enable an optimistic cache locking strategy, which may result in better performance at the cost of cache consistency. Setting this flag to <c>false</c> is only recommended for apps which create a new <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> per request. </summary> <remarks> This flag is <c>true</c> by default. The default behavior is recommended. </remarks> </member> <member name="T:Microsoft.Identity.Client.IAppConfig"> <summary> Configuration properties used to build a public or confidential client application. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientId"> <summary> Client ID (also known as App ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app). </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.EnablePiiLogging"> <summary> Flag telling if logging of Personally Identifiable Information (PII) is enabled/disabled for the application. See https://aka.ms/msal-net-logging. </summary> <seealso cref="P:Microsoft.Identity.Client.IAppConfig.IsDefaultPlatformLoggingEnabled"/> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.HttpClientFactory"> <summary> <see cref="T:Microsoft.Identity.Client.IMsalHttpClientFactory"/> used to get HttpClient instances to communicate with the identity provider. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.LogLevel"> <summary> Level of logging requested for the app. See https://aka.ms/msal-net-logging. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.IsDefaultPlatformLoggingEnabled"> <summary> Flag telling if logging to platform defaults is enabled/disabled for the app. In Desktop/UWP, Event Tracing is used. In iOS, NSLog is used. In Android, logcat is used. See https://aka.ms/msal-net-logging. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.RedirectUri"> <summary> Redirect URI for the application. See <see cref="P:Microsoft.Identity.Client.ApplicationOptions.RedirectUri"/> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.TenantId"> <summary> Audience for the application. See <see cref="P:Microsoft.Identity.Client.ApplicationOptions.TenantId"/> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.LoggingCallback"> <summary> Callback used for logging. It was set with <see cref="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"/> See https://aka.ms/msal-net-logging </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ExtraQueryParameters"> <summary> Extra query parameters that will be applied to every acquire token operation. See <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithExtraQueryParameters(System.Collections.Generic.IDictionary{System.String,System.String})"/> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.IsBrokerEnabled"> <summary> Indicates whether or not the current application object is configured to use brokered authentication. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientName"> <summary> The name of the calling application for telemetry purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientVersion"> <summary> The version of the calling application for telemetry purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.TelemetryConfig"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ExperimentalFeaturesEnabled"> <summary> Allows usage of features that are experimental and would otherwise throw a specific exception. Use of experimental features in production is not recommended and are subject to be removed between builds. For details see https://aka.ms/msal-net-experimental-features. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientCapabilities"> <summary> 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" </summary> <remarks> MSAL will transform these into a "access_token" claims request. See https://openid.net/specs/openid-connect-core-1_0-final.html#ClaimsParameter for details on claim requests. For more details see https://aka.ms/msal-net-claims-request </remarks> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.LegacyCacheCompatibilityEnabled"> <summary> Enables legacy ADAL cache serialization and deserialization. </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientSecret"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ClientCredentialCertificate"> <summary> </summary> </member> <member name="P:Microsoft.Identity.Client.IAppConfig.ParentActivityOrWindowFunc"> <summary> </summary> </member> <member name="T:Microsoft.Identity.Client.IMsalHttpClientFactory"> <summary> Factory responsible for creating HttpClient. See https://learn.microsoft.com/dotnet/api/system.net.http.httpclient?view=net-7.0#instancing for more details. </summary> <remarks> Implementations must be thread safe. Do not create a new HttpClient for each call to <see cref="M:Microsoft.Identity.Client.IMsalHttpClientFactory.GetHttpClient"/> - this leads to socket exhaustion. If your app uses Integrated Windows Authentication, ensure <see cref="P:System.Net.Http.HttpClientHandler.UseDefaultCredentials"/> is set to true. </remarks> </member> <member name="M:Microsoft.Identity.Client.IMsalHttpClientFactory.GetHttpClient"> <summary> Method returning an HTTP client that will be used to communicate with Azure AD. This enables advanced scenarios. See https://aka.ms/msal-net-application-configuration. </summary> <returns>An HTTP client.</returns> </member> <member name="T:Microsoft.Identity.Client.TelemetryAudienceType"> <summary> Describes the types of audiences for telemetry. <see cref="P:Microsoft.Identity.Client.ITelemetryConfig.AudienceType"/> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="F:Microsoft.Identity.Client.TelemetryAudienceType.PreProduction"> <summary> Indicates a PreProduction environment. PreProd environments are not sampled. </summary> </member> <member name="F:Microsoft.Identity.Client.TelemetryAudienceType.Production"> <summary> Indicates a Production environment. These environments are sampled based on the platforms' device info to reduce data load. </summary> </member> <member name="T:Microsoft.Identity.Client.ITelemetryConfig"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryConfig.AudienceType"> <summary> Communicates which audience the telemetry is for (e.g. Production or Pre-Production) so that MSAL.NET can change sampling and filtering behavior. </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryConfig.SessionId"> <summary> ID for the telemetry session. </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryConfig.DispatchAction"> <summary> Implementers of the interface will receive this callback when telemetry data is available. The implementation should transfer the data in ITelemetryEventPayload to a specific telemetry uploader instance. </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="T:Microsoft.Identity.Client.ITelemetryEventPayload"> <summary> Data that represents a single snapshot in the series of events that are collected </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryEventPayload.Name"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> <returns></returns> </member> <member name="P:Microsoft.Identity.Client.ITelemetryEventPayload.BoolValues"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryEventPayload.Int64Values"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryEventPayload.IntValues"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.ITelemetryEventPayload.StringValues"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="M:Microsoft.Identity.Client.ITelemetryEventPayload.ToJsonString"> <summary> Used for debugging and testing. </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.ManagedIdentityApplicationBuilder"> <summary> Builder for managed identity applications. </summary> </member> <member name="M:Microsoft.Identity.Client.ManagedIdentityApplicationBuilder.#ctor(Microsoft.Identity.Client.ApplicationConfiguration)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.ManagedIdentityApplicationBuilder.Create(Microsoft.Identity.Client.AppConfig.ManagedIdentityId)"> <summary> Creates a ManagedIdentityApplicationBuilder from a user assigned managed identity clientID / resourceId / objectId. For example, for a system assigned managed identity use ManagedIdentityApplicationBuilder.Create(ManagedIdentityId.SystemAssigned) and for a user assigned managed identity use ManagedIdentityApplicationBuilder.Create(ManagedIdentityId.WithUserAssignedClientId(clientId)) or ManagedIdentityId.WithUserAssignedResourceId("resourceId") or ManagedIdentityId.WithUserAssignedObjectId("objectid"). For more details see https://aka.ms/msal-net-managed-identity </summary> <param name="managedIdentityId">Configuration of the Managed Identity assigned to the resource.</param> <returns>A <see cref="T:Microsoft.Identity.Client.ManagedIdentityApplicationBuilder"/> from which to set more parameters, and to create a managed identity application instance</returns> </member> <member name="M:Microsoft.Identity.Client.ManagedIdentityApplicationBuilder.WithTelemetryClient(Microsoft.IdentityModel.Abstractions.ITelemetryClient[])"> <summary> Sets telemetry client for the application. </summary> <param name="telemetryClients">List of telemetry clients to add telemetry logs.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.ManagedIdentityApplicationBuilder.Build"> <summary> Builds the ManagedIdentityApplication from the parameters set in the builder </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ManagedIdentityApplicationBuilder.BuildConcrete"> <summary> </summary> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.AppConfig.ManagedIdentityId"> <summary> Class to store configuration for a managed identity enabled on a resource. For a system assigned managed identity use ManagedIdentityId.SystemAssigned. For user assigned managed identity use ManagedIdentityId.WithUserAssignedClientId("clientId") or ManagedIdentityId.WithUserAssignedResourceId("resourceId") or ManagedIdentityId.WithUserAssignedObjectId("objectid"). For more details see https://aka.ms/msal-net-managed-identity </summary> </member> <member name="P:Microsoft.Identity.Client.AppConfig.ManagedIdentityId.SystemAssigned"> <summary> Create an instance of ManagedIdentityId for a system assigned managed identity. </summary> </member> <member name="M:Microsoft.Identity.Client.AppConfig.ManagedIdentityId.WithUserAssignedClientId(System.String)"> <summary> Create an instance of ManagedIdentityId for a user assigned managed identity from a client id. </summary> <param name="clientId">Client id of the user assigned managed identity assigned to the azure resource.</param> <returns>Instance of ManagedIdentityId.</returns> <exception cref="T:System.ArgumentNullException"></exception> </member> <member name="M:Microsoft.Identity.Client.AppConfig.ManagedIdentityId.WithUserAssignedResourceId(System.String)"> <summary> Create an instance of ManagedIdentityId for a user assigned managed identity from a resource id. </summary> <param name="resourceId">Resource id of the user assigned managed identity assigned to the azure resource.</param> <returns>Instance of ManagedIdentityId.</returns> <exception cref="T:System.ArgumentNullException"></exception> </member> <member name="M:Microsoft.Identity.Client.AppConfig.ManagedIdentityId.WithUserAssignedObjectId(System.String)"> <summary> Create an instance of ManagedIdentityId for a user assigned managed identity from an object id. </summary> <param name="objectId">Object id of the user assigned managed identity assigned to the azure resource.</param> <returns>Instance of ManagedIdentityId.</returns> <exception cref="T:System.ArgumentNullException"></exception> </member> <member name="T:Microsoft.Identity.Client.AppConfig.MsalClientType"> <summary> Enum to represent the type of MSAL application. </summary> </member> <member name="T:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration"> <summary> Details about the HTTP request and configuration properties used to construct a proof of possession request. </summary> <remarks> POP tokens are signed by the process making the request. By default, MSAL will generate a key in memory. To use a hardware key or an external key, implement <see cref="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.PopCryptoProvider"/>. </remarks> </member> <member name="M:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.#ctor"> <summary> Creates a configuration using the default key management - an RSA key will be created in memory and rotated every 8h. Uses <see cref="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.HttpMethod"/>, <see cref="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.HttpHost"/> etc. to control which elements of the request should be included in the POP token. </summary> <remarks> See https://datatracker.ietf.org/doc/html/draft-ietf-oauth-signed-http-request-03#page-3 for details about signed HTTP requests. </remarks> </member> <member name="M:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.#ctor(System.Net.Http.HttpRequestMessage)"> <summary> Creates a configuration using the default key management, and which binds all the details of the HttpRequestMessage. </summary> <remarks> Currently only the HttpMethod (m), UrlHost (u) and UrlPath (p) are used to create the signed HTTP request - see https://datatracker.ietf.org/doc/html/draft-ietf-oauth-signed-http-request-03#page-3 </remarks> </member> <member name="M:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.#ctor(System.Uri)"> <summary> Creates a configuration using the default key management, and which binds only the Uri part of the HTTP request. </summary> <remarks> The UrlHost (u) and UrlPath (p) are used to create the signed HTTP request - see https://datatracker.ietf.org/doc/html/draft-ietf-oauth-signed-http-request-03#page-3 </remarks> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.HttpMethod"> <summary> The HTTP method ("GET", "POST" etc.) method that will be bound to the token. Leave null and the POP token will not be bound to the method. Corresponds to the "m" part of the a signed HTTP request. Optional. </summary> <remarks> See https://datatracker.ietf.org/doc/html/draft-ietf-oauth-signed-http-request-03#section-3 </remarks> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.HttpHost"> <summary> The URL host of the protected API. The "u" part of a signed HTTP request. This MAY include the port separated from the host by a colon in host:port format. Optional. </summary> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.HttpPath"> <summary> The "p" part of the signed HTTP request. </summary> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.PopCryptoProvider"> <summary> An extensibility point that allows developers to define their own key management. Leave <c>null</c> and MSAL will use a default implementation, which generates an RSA key pair in memory and refreshes it every 8 hours. Important note: if you want to change the key (e.g. rotate the key), you should create a new instance of this object, as MSAL.NET will keep a thumbprint of keys in memory. </summary> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.Nonce"> <summary> If the protected resource (RP) requires use of a special nonce, they will publish it as part of the WWWAuthenticate header associated with a 401 HTTP response or as part of the AuthorityInfo header associated with 200 response. Set it here to make it part of the Signed HTTP Request part of the POP token. </summary> </member> <member name="P:Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration.SignHttpRequest"> <summary> Allows app developers to bypass the creation of the SignedHttpRequest envelope by setting this property to false. App developers can use a package like Microsoft.IdentityModel.Protocols.SignedHttpRequest to later create and sign the envelope. </summary> <remarks> If set to false, you do not need to implement the <see cref="M:Microsoft.Identity.Client.AuthScheme.PoP.IPoPCryptoProvider.Sign(System.Byte[])"/> method when using custom keys. </remarks> </member> <member name="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.#ctor(Microsoft.Identity.Client.ApplicationConfiguration)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.CreateWithApplicationOptions(Microsoft.Identity.Client.PublicClientApplicationOptions)"> <summary> Creates a PublicClientApplicationBuilder from public client application configuration options. See https://aka.ms/msal-net-application-configuration </summary> <param name="options">Public client applications configuration options</param> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.Create(System.String)"> <summary> Creates a PublicClientApplicationBuilder from a clientID. See https://aka.ms/msal-net-application-configuration </summary> <param name="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)/.</param> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithDefaultRedirectUri"> <summary> Configures the public client application to use the recommended reply URI for the platform. See https://aka.ms/msal-net-default-reply-uri. <list type="table"> <listheader> <term>Platform</term> <Description>Default Reply URI</Description> </listheader> <item> <term>.NET desktop</term> <Description><c>https://login.microsoftonline.com/common/oauth2/nativeclient</c></Description> </item> <item> <term>UWP</term> <Description>value of <c>WebAuthenticationBroker.GetCurrentApplicationCallbackUri()</c></Description> </item> <item> <term>For system browser on .NET Core</term> <Description><c>http://localhost</c></Description> </item> </list> NOTE:There will be an update to the default redirect URI in the future to accommodate for system browsers on the .NET desktop and .NET Core platforms. </summary> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithMultiCloudSupport(System.Boolean)"> <summary> Enables multi cloud support for this instance of public client application. It enables applications to use in a global public cloud authority to the library and can still get tokens for resources from sovereign clouds. </summary> <param name="enableMultiCloudSupport">Enable or disable multi cloud support.</param> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> <remarks>This feature is available to Microsoft applications, which have the same client id across all clouds</remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithIosKeychainSecurityGroup(System.String)"> <summary> You can specify a Keychain Access Group to use for persisting the token cache across multiple applications. This enables you to share the token cache between several applications having the same Keychain access group. Sharing the token cache allows single sign-on between all of the applications that use the same Keychain access Group. See https://aka.ms/msal-net-ios-keychain-security-group for more information. </summary> <param name="keychainSecurityGroup"></param> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithBroker(System.Boolean)"> <summary> Brokers enable Single-Sign-On, device identification, and application identification verification. To enable one of these features, you need to set the WithBroker() parameters to true. See https://aka.ms/msal-net-wam for more information on platform specific settings required to enable the broker. On iOS and Android, Authenticator and Company Portal serve as brokers. On Windows, WAM (Windows Account Manager) serves as broker. See https://aka.ms/msal-net-wam </summary> <param name="enableBroker">Determines whether or not to use broker with the default set to true.</param> <returns>A <see cref="T:Microsoft.Identity.Client.PublicClientApplicationBuilder"/> from which to set more parameters, and to create a public client application instance</returns> <remarks>If your app uses .NET classic or .NET, and you wish to use the Windows broker, please install the NuGet package Microsoft.Identity.Client.Broker and call .WithBroker(BrokerOptions). This is not needed if for MAUI apps or for apps targeting net6-windows or higher.</remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithWindowsBrokerOptions(Microsoft.Identity.Client.WindowsBrokerOptions)"> <summary> Allows customization of the Windows 10 Broker experience. </summary> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithParentActivityOrWindow(System.Func{System.Object})"> <summary> Sets a reference to the ViewController (if using Xamarin.iOS), Activity (if using Xamarin.Android) IWin32Window or IntPtr (if using .Net Framework). Used for invoking the browser. </summary> <remarks> Mandatory only on Android to be set either from here or from AcquireTokenInteractive builder. See https://aka.ms/msal-net-android-activity for further documentation and details. </remarks> <param name="parentActivityOrWindowFunc">The parent as an object, so that it can be used from shared NetStandard assemblies</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithParentActivityOrWindow(System.Func{System.Windows.Forms.IWin32Window})"> <summary> Sets a reference to the current IWin32Window that triggers the browser to be shown. Used to center the browser that pop-up onto this window. </summary> <param name="windowFunc">A function to return the current window</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithParentActivityOrWindow(System.Func{System.IntPtr})"> <summary> Sets a reference to the IntPtr to a window that triggers the browser to be shown. Used to center the browser that pop-up onto this window. </summary> <param name="windowFunc">A function to return the current window</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.WithKerberosTicketClaim(System.String,Microsoft.Identity.Client.Kerberos.KerberosTicketContainer)"> <summary> Sets the parameters required to get a Kerberos Ticket from Azure AD service. </summary> <param name="servicePrincipalName">Service principal name to get Kerberos Service Ticket.</param> <param name="ticketContainer">Container to use for Kerberos Ticket.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.IsBrokerAvailable"> <summary> Returns <c>true</c> if a broker can be used. This method is only needed to be used in mobile scenarios which support Mobile Application Management. In other supported scenarios, use <c>WithBroker</c> by itself, which will fall back to use a browser if broker is unavailable. </summary> <remarks> <list type="bullet"> <item><description>On Windows, the broker (WAM) can be used on Windows 10 and is always installed. See https://aka.ms/msal-net-wam </description></item> <item><description>On Mac, Linux, and older versions of Windows a broker is not available.</description></item> <item><description>In .NET 6 apps, target <c>net6.0-windows10.0.17763.0</c> for all Windows versions and target <c>net6.0</c> for Linux and Mac.</description></item> <item><description>In .NET classic or .NET Core 3.1 apps, install Microsoft.Identity.Client.Desktop first and call <c>WithDesktopFeatures()</c>.</description></item> <item><description>In mobile apps, the device must be Intune joined and Authenticator or Company Portal must be installed. See https://aka.ms/msal-brokers </description></item> </list> </remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.Build"> <summary> </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.BuildConcrete"> <summary> </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationBuilder.Validate"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.PublicClientApplicationOptions"> <summary> Configuration options for a public client application (desktop/mobile app). See https://aka.ms/msal-net/application-configuration </summary> </member> <member name="T:Microsoft.Identity.Client.TraceTelemetryConfig"> <summary> A simple <see cref="T:Microsoft.Identity.Client.ITelemetryConfig"/> implementation that writes data using System.Diagnostics.Trace. </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="M:Microsoft.Identity.Client.TraceTelemetryConfig.#ctor"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.TraceTelemetryConfig.AudienceType"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.TraceTelemetryConfig.SessionId"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.TraceTelemetryConfig.DispatchAction"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="P:Microsoft.Identity.Client.TraceTelemetryConfig.AllowedScopes"> <summary> </summary> <remarks>This API is experimental and it may change in future versions of the library without an major version increment</remarks> </member> <member name="T:Microsoft.Identity.Client.ApplicationBase"> <inheritdoc/> </member> <member name="F:Microsoft.Identity.Client.ApplicationBase.DefaultAuthority"> <summary> Default Authority used for interactive calls. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthenticationHeaderParser"> <summary> Parsed authentication headers to retrieve header values from HttpResponseHeaders. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationHeaderParser.WwwAuthenticateParameters"> <summary> Parameters returned by the WWW-Authenticate header. This allows for dynamic scenarios such as claim challenge, CAE, CA auth context. See https://aka.ms/msal-net/wwwAuthenticate. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationHeaderParser.AuthenticationInfoParameters"> <summary> Parameters returned by the Authentication-Info header. This allows for authentication scenarios such as Proof-Of-Possession. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationHeaderParser.PopNonce"> <summary> Nonce parsed from HttpResponseHeaders. This is acquired from with the POP WWW-Authenticate header or the Authetnciation-Info header </summary> </member> <member name="M:Microsoft.Identity.Client.AuthenticationHeaderParser.ParseAuthenticationHeadersAsync(System.String,System.Threading.CancellationToken)"> <summary> Creates the authenticate parameters by attempting to call the resource unauthenticated, and analyzing the response. </summary> <param name="resourceUri">URI of the resource.</param> <param name="cancellationToken">The cancellation token to cancel the operation.</param> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AuthenticationHeaderParser.ParseAuthenticationHeadersAsync(System.String,System.Net.Http.HttpClient,System.Threading.CancellationToken)"> <summary> Creates the authenticate parameters by attempting to call the resource unauthenticated, and analyzing the response. </summary> <param name="resourceUri">URI of the resource.</param> <param name="cancellationToken">The cancellation token to cancel operation.</param> <param name="httpClient">Instance of <see cref="T:System.Net.Http.HttpClient"/> to make the request with.</param> <returns></returns> <exception cref="T:System.ArgumentNullException"></exception> </member> <member name="M:Microsoft.Identity.Client.AuthenticationHeaderParser.ParseAuthenticationHeaders(System.Net.Http.Headers.HttpResponseHeaders)"> <summary> Creates a parsed set of parameters from the provided HttpResponseHeaders. </summary> <param name="httpResponseHeaders"></param> <remarks>For known values, such as the nonce used for Proof-of-Possession, the parser will first check for it in the WWW-Authenticate headers If it cannot find it, it will then check the Authentication-Info parameters for the value.</remarks> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.AuthenticationHeaderParser.GetHttpClient"> <summary> Creates a HttpClient </summary> </member> <member name="M:Microsoft.Identity.Client.AuthenticationHeaderParser.CreateKeyValuePair(System.String,System.String)"> <summary> Creates a key value pair from an expression of the form a=b is possible. Otherwise, the key value pair will be returned as (key:<paramref name="authScheme"/>, value:<paramref name="paramValue"/>) </summary> <param name="paramValue">assignment</param> <param name="authScheme">authScheme</param> <returns>Key Value pair</returns> </member> <member name="T:Microsoft.Identity.Client.AuthenticationInfoParameters"> <summary> Parameters returned by the Authentication-Info header. This allows for scenarios such as proof-of-possession, etc. See https://www.rfc-editor.org/rfc/rfc7615 </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationInfoParameters.NextNonce"> <summary> The next nonce to be used in the preceding authentication request. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationInfoParameters.Item(System.String)"> <summary> Return the <see cref="P:Microsoft.Identity.Client.AuthenticationInfoParameters.RawParameters"/> of key <paramref name="key"/>. </summary> <param name="key">Name of the raw parameter to retrieve.</param> <returns>The raw parameter if it exists, or throws a <see cref="T:System.Collections.Generic.KeyNotFoundException"/> otherwise. </returns> </member> <member name="P:Microsoft.Identity.Client.AuthenticationInfoParameters.RawParameters"> <summary> Dictionary of raw parameters in the Authentication-Info header (extracted from the Authentication-Info header string value, without any processing). This allows support for APIs which are not mappable easily to the standard or framework specific (Microsoft.Identity.Model, Microsoft.Identity.Web). </summary> </member> <member name="M:Microsoft.Identity.Client.AuthenticationInfoParameters.CreateFromResponseHeaders(System.Net.Http.Headers.HttpResponseHeaders)"> <summary> Create Authentication-Info parameters from the HttpResponseHeaders for each auth scheme. </summary> <param name="httpResponseHeaders">HttpResponseHeaders.</param> <returns>Authentication-Info provided by the endpoint</returns> </member> <member name="T:Microsoft.Identity.Client.AuthenticationResult"> <summary> Contains the results of one token acquisition operation in <see cref="T:Microsoft.Identity.Client.PublicClientApplication"/> or ConfidentialClientApplication. For details see https://aka.ms/msal-net-authenticationresult </summary> </member> <member name="M:Microsoft.Identity.Client.AuthenticationResult.#ctor(System.String,System.Boolean,System.String,System.DateTimeOffset,System.DateTimeOffset,System.String,Microsoft.Identity.Client.IAccount,System.String,System.Collections.Generic.IEnumerable{System.String},System.Guid,System.String,Microsoft.Identity.Client.AuthenticationResultMetadata,System.Security.Claims.ClaimsPrincipal,System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})"> <summary> Constructor meant to help application developers test their apps. Allows mocking of authentication flows. App developers should <b>never</b> new-up <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> in product code. </summary> <param name="accessToken">Access Token that can be used as a bearer token to access protected web APIs</param> <param name="account">Account information</param> <param name="expiresOn">Expiry date-time for the access token</param> <param name="extendedExpiresOn">See <see cref="P:Microsoft.Identity.Client.AuthenticationResult.ExtendedExpiresOn"/></param> <param name="idToken">ID token</param> <param name="isExtendedLifeTimeToken">See <see cref="P:Microsoft.Identity.Client.AuthenticationResult.IsExtendedLifeTimeToken"/></param> <param name="scopes">Granted scope values as returned by the service</param> <param name="tenantId">Identifier for the Azure AD tenant from which the token was acquired. Can be <c>null</c></param> <param name="uniqueId">Unique Id of the account. It can be null. When the <see cref="P:Microsoft.Identity.Client.AuthenticationResult.IdToken"/> is not <c>null</c>, this is its ID, that is its ObjectId claim, or if that claim is <c>null</c>, the Subject claim.</param> <param name="correlationId">The correlation id of the authentication request</param> <param name="tokenType">The token type, defaults to Bearer. Note: this property is experimental and may change in future versions of the library.</param> <param name="authenticationResultMetadata">Contains metadata related to the Authentication Result.</param> <param name="claimsPrincipal">Claims from the ID token</param> <param name="spaAuthCode">Auth Code returned by the Microsoft identity platform when you use AcquireTokenByAuthorizationCode.WithSpaAuthorizationCode(). This auth code is meant to be redeemed by the frontend code. See https://aka.ms/msal-net/spa-auth-code</param> <param name="additionalResponseParameters">Other properties from the token response.</param> </member> <member name="M:Microsoft.Identity.Client.AuthenticationResult.#ctor(System.String,System.Boolean,System.String,System.DateTimeOffset,System.DateTimeOffset,System.String,Microsoft.Identity.Client.IAccount,System.String,System.Collections.Generic.IEnumerable{System.String},System.Guid,Microsoft.Identity.Client.AuthenticationResultMetadata,System.String)"> <summary> Constructor meant to help application developers test their apps. Allows mocking of authentication flows. App developers should <b>never</b> new-up <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> in product code. </summary> <param name="accessToken">Access Token that can be used as a bearer token to access protected web APIs</param> <param name="account">Account information</param> <param name="expiresOn">Expiry date-time for the access token</param> <param name="extendedExpiresOn">See <see cref="P:Microsoft.Identity.Client.AuthenticationResult.ExtendedExpiresOn"/></param> <param name="idToken">ID token</param> <param name="isExtendedLifeTimeToken">See <see cref="P:Microsoft.Identity.Client.AuthenticationResult.IsExtendedLifeTimeToken"/></param> <param name="scopes">Granted scope values as returned by the service</param> <param name="tenantId">Identifier for the Azure AD tenant from which the token was acquired. Can be <c>null</c></param> <param name="uniqueId">Unique Id of the account. It can be null. When the <see cref="P:Microsoft.Identity.Client.AuthenticationResult.IdToken"/> is not <c>null</c>, this is its ID, that is its ObjectId claim, or if that claim is <c>null</c>, the Subject claim.</param> <param name="correlationId">The correlation id of the authentication request</param> <param name="authenticationResultMetadata">Contains metadata related to the Authentication Result.</param> <param name="tokenType">The token type, defaults to Bearer. Note: this property is experimental and may change in future versions of the library.</param> <remarks>For backwards compatibility with MSAL 4.17-4.20 </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.AccessToken"> <summary> Access Token that can be used as a bearer token to access protected web APIs </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.IsExtendedLifeTimeToken"> <summary> In case when Azure AD has an outage, to be more resilient, it can return tokens with an expiration time, and also with an extended expiration time. The tokens are then automatically refreshed by MSAL when the time is more than the expiration time, except when ExtendedLifeTimeEnabled is true and the time is less than the extended expiration time. This goes in pair with Web APIs middleware which, when this extended life time is enabled, can accept slightly expired tokens. Client applications accept extended life time tokens only if the ExtendedLifeTimeEnabled Boolean is set to true on ClientApplicationBase. </summary> <remarks>This feature is not in use</remarks> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.UniqueId"> <summary> Gets the Unique Id of the account in this <see cref="P:Microsoft.Identity.Client.AuthenticationResult.TenantId" /> It is set as the oid (ObjectId) claim, or if that claim is <c>null</c>, as the sub (Subject) claim which is guaranteed not-null. </summary> <remarks> The oid claim identifies a user in all apps - Microsoft Identity Providers issue ID tokens with this claim, although it can be null in rare cases. The sub claim is "a locally unique and never reassigned identifier within the Issuer for the End-User" as per https://openid.net/specs/openid-connect-core-1_0.html and it is a mandatory claim with OIDC compliant issuers. Guest AAD accounts have different oid claim values in each tenant. Use <see cref="P:Microsoft.Identity.Client.Account.HomeAccountId"/> to uniquely identify users across tenants. See https://docs.microsoft.com/azure/active-directory/develop/id-tokens#payload-claims </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.ExpiresOn"> <summary> Gets the point in time in which the Access Token returned in the <see cref="P:Microsoft.Identity.Client.AuthenticationResult.AccessToken"/> property ceases to be valid. This value is calculated based on current UTC time measured locally and the value expiresIn received from the service. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.ExtendedExpiresOn"> <summary> Gets the point in time in which the Access Token returned in the AccessToken property ceases to be valid in MSAL's extended LifeTime. This value is calculated based on current UTC time measured locally and the value ext_expiresIn received from the service. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.TenantId"> <summary> Gets an identifier for the Azure AD tenant from which the token was acquired. This property will be null if tenant information is not returned by the service. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.Account"> <summary> Gets the account information. Some elements in <see cref="T:Microsoft.Identity.Client.IAccount"/> might be null if not returned by the service. The account can be passed back in some API overloads to identify which account should be used such as <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> or <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)"/> for instance </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.IdToken"> <summary> Gets the Id Token if returned by the service or null if no Id Token is returned. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.Scopes"> <summary> Gets the granted scope values returned by the service. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.CorrelationId"> <summary> Gets the correlation id used for the request. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.TokenType"> <summary> Identifies the type of access token. By default tokens returned by Azure Active Directory are Bearer tokens. <seealso cref="M:Microsoft.Identity.Client.AuthenticationResult.CreateAuthorizationHeader"/> for getting an HTTP authorization header from an AuthenticationResult. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.SpaAuthCode"> <summary> Gets the SPA Authorization Code, if it was requested using WithSpaAuthorizationCode method on the AcquireTokenByAuthorizationCode builder. See https://aka.ms/msal-net/spa-auth-code for details. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.AdditionalResponseParameters"> <summary> Exposes additional response parameters returned by the token issuer (AAD). </summary> <remarks> Not all parameters are added here, only the ones that MSAL doesn't interpret itself and only scalars. Not supported on mobile frameworks (e.g. net6-android or net6-ios) </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.ClaimsPrincipal"> <summary> All the claims present in the ID token. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.AuthenticationResultMetadata"> <summary> Contains metadata for the Authentication result. </summary> </member> <member name="M:Microsoft.Identity.Client.AuthenticationResult.CreateAuthorizationHeader"> <summary> Creates the content for an HTTP authorization header from this authentication result, so that you can call a protected API </summary> <returns>Created authorization header of the form "Bearer {AccessToken}"</returns> <example> Here is how you can call a protected API from this authentication result (in the <c>result</c> variable): <code> HttpClient client = new HttpClient(); client.DefaultRequestHeaders.Add("Authorization", result.CreateAuthorizationHeader()); HttpResponseMessage r = await client.GetAsync(urlOfTheProtectedApi); </code> </example> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResult.User"> <summary> In MSAL.NET 1.x, returned the user who signed in to get the authentication result. From MSAL 2.x rather use <see cref="P:Microsoft.Identity.Client.AuthenticationResult.Account"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthenticationResultMetadata"> <summary> Contains metadata of the authentication result. <see cref="T:Microsoft.Identity.Client.Metrics"/> for additional MSAL-wide metrics. </summary> </member> <member name="M:Microsoft.Identity.Client.AuthenticationResultMetadata.#ctor(Microsoft.Identity.Client.TokenSource)"> <summary> Constructor for the class AuthenticationResultMetadata <param name="tokenSource">The token source.</param> </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.TokenSource"> <summary> The source of the token in the result. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.TokenEndpoint"> <summary> The token endpoint used to contact the Identity Provider (e.g. Azure Active Directory). Can be null, for example when the token comes from the cache. </summary> <remarks> This may be different from the endpoint you'd infer from the authority configured in the application object: - if regional auth is used. - if AAD instructs MSAL to use a different environment. - if the authority or tenant is overridden at the request level. - during a refresh_token operation, when MSAL must resolve "common" and "organizations" to a tenant ID. </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationTotalInMs"> <summary> Time, in milliseconds, spent to service this request. Includes time spent making HTTP requests <see cref="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInHttpInMs"/>, time spent in token cache callbacks <see cref="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInCacheInMs"/>, time spent in MSAL and context switching. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInCacheInMs"> <summary> Time, in milliseconds, MSAL spent during this request reading and writing to the token cache, i.e. in the OnBeforeAccess, OnAfterAccess, etc. callbacks. Does not include internal MSAL logic for searching through the cache once loaded. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInHttpInMs"> <summary> Time, in milliseconds, MSAL spent for HTTP communication during this request. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.RefreshOn"> <summary> Specifies the time when the cached token should be proactively refreshed. This value may be null if proactive refresh is not enabled. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.CacheRefreshReason"> <summary> Specifies the reason for fetching the access token from the identity provider. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.RegionDetails"> <summary> Contains the Outcome of the region discovery if Region was used. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthenticationResultMetadata.Telemetry"> <summary> May contain telemetry data. </summary> <remarks> Currently it is emitted only for desktop public client flows when the broker is used and it is also included in the verbose logs. May contain Personal Identifiable Information (PII), as per the logging settings. See https://aka.ms/msal-net-logging for more details about logging. </remarks> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.AuthSchemeHelper.StoreTokenTypeInCacheKey(System.String)"> <summary> For backwards compatibility reasons, keep the cache key unchanged for Bearer and SSH tokens. For PoP and future tokens, the cache should support both several types of tokens for the same scope (e.g. PoP and Bearer) </summary> <param name="tokenType"></param> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme"> <summary> Used to modify the experience depending on the type of token asked. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.TelemetryTokenType"> <summary> Value to log to telemetry to indicate pop usage. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.AuthorizationHeaderPrefix"> <summary> Prefix for the HTTP header that has the token. E.g. "Bearer" or "POP" </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.GetTokenRequestParams"> <summary> Extra parameters that are added to the request to the /token endpoint. </summary> <returns>Name and values of params</returns> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.KeyId"> <summary> Key ID of the public / private key pair used by the encryption algorithm, if any. Tokens obtained by authentication schemes that use this are bound to the KeyId, i.e. if a different kid is presented, the access token cannot be used. </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.FormatAccessToken(Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem)"> <summary> Creates the access token that goes into an Authorization HTTP header. </summary> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.IAuthenticationScheme.AccessTokenType"> <summary> Expected to match the token_type parameter returned by ESTS. Used to disambiguate between ATs of different types (e.g. Bearer and PoP) when loading from cache etc. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.PoP.InMemoryCryptoProvider"> <summary> The default implementation will store a key in memory </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.PoP.InMemoryCryptoProvider.ComputeCanonicalJwk(System.Security.Cryptography.RSAParameters)"> <summary> Creates the canonical representation of the JWK. See https://tools.ietf.org/html/rfc7638#section-3. The number of parameters as well as the lexicographic order is important, as this string will be hashed to get a thumbprint. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.PoP.IPoPCryptoProvider"> <summary> An abstraction over an the asymmetric key operations needed by POP, that encapsulates a pair of public and private keys and some typical crypto operations. All symmetric operations are SHA256. </summary> <remarks> Important: The 2 methods on this interface will be called at different times but MUST return details of the same private / public key pair, i.e. do not change to a different key pair mid way. Best to have this class immutable. Ideally there should be a single public / private key pair associated with a machine, so implementers of this interface should consider exposing a singleton. </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.PoP.IPoPCryptoProvider.CannonicalPublicKeyJwk"> <summary> The canonical representation of the JWK. See https://tools.ietf.org/html/rfc7638#section-3 </summary> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.PoP.IPoPCryptoProvider.CryptographicAlgorithm"> <summary> Algorithm used to sign proof of possession request. See https://docs.microsoft.com/en-us/azure/key-vault/keys/about-keys#signverify for ECD See https://docs.microsoft.com/en-us/azure/key-vault/keys/about-keys#signverify-1 for RSA </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.PoP.IPoPCryptoProvider.Sign(System.Byte[])"> <summary> Signs the byte array using the private key </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.PoP.JsonWebKeyParameterNames"> <summary> Names for Json Web Key Values </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.PoP.JsonWebAlgorithmsKeyTypes"> <summary> Constants for JsonWebAlgorithms "kty" Key Type (sec 6.1) http://tools.ietf.org/html/rfc7518#section-6.1 </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.PoP.PopAuthenticationScheme.#ctor(Microsoft.Identity.Client.AppConfig.PoPAuthenticationConfiguration,Microsoft.Identity.Client.Internal.IServiceBundle)"> <summary> Creates POP tokens, i.e. tokens that are bound to an HTTP request and are digitally signed. </summary> <remarks> Currently the signing credential algorithm is hard-coded to RSA with SHA256. Extensibility should be done by integrating Wilson's SigningCredentials </remarks> </member> <member name="P:Microsoft.Identity.Client.AuthScheme.PoP.PopAuthenticationScheme.KeyId"> <summary> For PoP, we chose to use the base64(jwk_thumbprint) </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.PoP.PopAuthenticationScheme.ComputeThumbprint(System.String)"> <summary> A key ID that uniquely describes a public / private key pair. While KeyID is not normally strict, AAD support for PoP requires that we use the base64 encoded JWK thumbprint, as described by https://tools.ietf.org/html/rfc7638 </summary> </member> <member name="M:Microsoft.Identity.Client.AuthScheme.PoP.PopAuthenticationScheme.CreateJWS(System.String,System.String)"> <summary> Creates a JWS (json web signature) as per: https://tools.ietf.org/html/rfc7515 Format: header.payload.signed_payload </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.At"> <summary> Access token with response cnf https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.HttpMethod"> <summary> Http method (GET or POST) https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Ts"> <summary> Timestamp https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Host"> <summary> Uri host https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Path"> <summary> Uri path https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Query"> <summary> Uri path https://tools.ietf.org/html/draft-ietf-oauth-signed-http-request-03#section-3 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Cnf"> <summary> Confirmation claim. By including this in a JWT, the issuer states that the presenter possesses a particular key (i.e. the private key) and that the recipient can confirm this cryptographically. https://tools.ietf.org/html/rfc7800 </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.JWK"> <summary> Also part of the confirmation claim. <seealso cref="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Cnf"/> </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.PoP.PoPClaimTypes.Nonce"> <summary> Non-standard claim representing a nonce that protects against replay attacks. </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.PoP.PoPProviderFactory"> <summary> This factory ensures key rotation every 8h </summary> </member> <member name="T:Microsoft.Identity.Client.AuthScheme.TokenType"> <summary> Specifies the token type to log to telemetry. </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.TokenType.Bearer"> <summary> Bearer token type. </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.TokenType.Pop"> <summary> Pop token type. </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.TokenType.SshCert"> <summary> Ssh-cert token type. </summary> </member> <member name="F:Microsoft.Identity.Client.AuthScheme.TokenType.External"> <summary> External token type. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.AdalResult"> <summary> Contains the results of an ADAL token acquisition. Access Tokens from ADAL are not compatible with MSAL, only Refresh Tokens are. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalResult.UserInfo"> <summary> Gets user information including user Id. Some elements in UserInfo might be null if not returned by the service. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalResultWrapper.RefreshToken"> <summary> Gets the Refresh Token associated with the requested Access Token. Note: not all operations will return a Refresh Token. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalResultWrapper.IsMultipleResourceRefreshToken"> <summary> Gets a value indicating whether the refresh token can be used for requesting access token for other resources. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalResultWrapper.Deserialize(System.String)"> <summary> Serializes the object to a JSON string </summary> <returns>Deserialized authentication result</returns> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalResultWrapper.Serialize"> <summary> Serializes the object to a JSON string </summary> <returns>Serialized authentication result</returns> </member> <member name="T:Microsoft.Identity.Client.Cache.TokenSubjectType"> <summary> Determines what type of subject the token was issued for. </summary> </member> <member name="F:Microsoft.Identity.Client.Cache.TokenSubjectType.User"> <summary> User </summary> </member> <member name="F:Microsoft.Identity.Client.Cache.TokenSubjectType.Client"> <summary> Client </summary> </member> <member name="F:Microsoft.Identity.Client.Cache.TokenSubjectType.UserPlusClient"> <summary> UserPlusClient: This is for confidential clients used in middle tier. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.AdalTokenCacheKey"> <summary> <see cref="T:Microsoft.Identity.Client.Cache.AdalTokenCacheKey"/> can be used with Linq to access items from the TokenCache dictionary. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalTokenCacheKey.Resource"> <summary> For the purposes of MSAL, the resource is irrelevant, since only RTs can be migrated. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalTokenCacheKey.Equals(System.Object)"> <summary> Determines whether the specified object is equal to the current object. </summary> <returns> true if the specified object is equal to the current object; otherwise, false. </returns> <param name="obj">The object to compare with the current object. </param><filterpriority>2</filterpriority> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalTokenCacheKey.Equals(Microsoft.Identity.Client.Cache.AdalTokenCacheKey)"> <summary> Determines whether the specified TokenCacheKey is equal to the current object. </summary> <returns> true if the specified TokenCacheKey is equal to the current object; otherwise, false. </returns> <param name="other">The TokenCacheKey to compare with the current object. </param><filterpriority>2</filterpriority> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalTokenCacheKey.GetHashCode"> <summary> Returns the hash code for this TokenCacheKey. </summary> <returns> A 32-bit signed integer hash code. </returns> </member> <member name="T:Microsoft.Identity.Client.Cache.AdalUserInfo"> <summary> Contains information of a single user. This information is used for token cache lookup. Also if created with userId, userId is sent to the service when login_hint is accepted. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalUserInfo.#ctor"> <summary> Create user information for token cache lookup </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.AdalUserInfo.#ctor(Microsoft.Identity.Client.Cache.AdalUserInfo)"> <summary> Create user information copied from another UserInfo object </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.UniqueId"> <summary> Gets identifier of the user authenticated during token acquisition. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.DisplayableId"> <summary> Gets a displayable value in UserPrincipalName (UPN) format. The value can be null. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.GivenName"> <summary> Gets given name of the user if provided by the service. If not, the value is null. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.FamilyName"> <summary> Gets family name of the user if provided by the service. If not, the value is null. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.PasswordExpiresOn"> <summary> Gets the time when the password expires. Default value is 0. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.PasswordChangeUrl"> <summary> Gets the URL where the user can change the expiring password. The value can be null. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.AdalUserInfo.IdentityProvider"> <summary> Gets identity provider if returned by the service. If not, the value is null. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.CacheData"> <summary> Data class, common to ADAL.NET and MSAL.NET V2 used for the token cache serialization in a dual format: the ADAL V3 cache format, and the new unified cache format, common to ADAL.NET 4.x, MSAL.NET 2.x and other libraries in the same Operating System (for instance ADAL and MSAL for objective C in iOS) </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.CacheData.AdalV3State"> <summary> Array of bytes containing the serialized cache in ADAL.NET V3 format </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.CacheData.UnifiedState"> <summary> Array of bytes containing the serialized MSAL.NET V2 cache </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.CacheFallbackOperations.GetAllAdalUsersForMsal(Microsoft.Identity.Client.Core.ILoggerAdapter,Microsoft.Identity.Client.Cache.ILegacyCachePersistence,System.String)"> <summary> Returns a tuple where Item1 is a map of ClientInfo -> AdalUserInfo for those users that have ClientInfo Item2 is a list of AdalUserInfo for those users that do not have ClientInfo </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.CacheFallbackOperations.RemoveAdalUser(Microsoft.Identity.Client.Core.ILoggerAdapter,Microsoft.Identity.Client.Cache.ILegacyCachePersistence,System.String,System.String,System.String)"> <summary> Algorithm to delete: DisplayableId cannot be null Removal is scoped by environment and clientId; If accountId != null then delete everything with the same clientInfo otherwise, delete everything with the same displayableId Notes: - displayableId can change rarely - ClientCredential Grant uses the app token cache, not the user token cache, so this algorithm does not apply (nor will GetAccounts / RemoveAccount work) </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.CacheKeyFactory"> <summary> Responsible for computing: - external distributed cache key (from request and responses) - internal cache partition keys (as above, but also from cache items) These are the same string, but MSAL cannot control if the app developer actually uses distributed caching. However, MSAL's in-memory cache needs to be partitioned, and this class computes the partition key. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.CacheLevel"> <summary> Identifies the type of cache that the token was read from. Cache implementations must provide this. </summary> </member> <member name="F:Microsoft.Identity.Client.Cache.CacheLevel.None"> <summary> Specifies that the cache level used is None. Token was retrieved from ESTS </summary> </member> <member name="F:Microsoft.Identity.Client.Cache.CacheLevel.Unknown"> <summary> Specifies that the cache level used is unknown. Token was retrieved from cache but the token cache implementation didn't specify which cache level was used. </summary> </member> <member name="F:Microsoft.Identity.Client.Cache.CacheLevel.L1Cache"> <summary> Specifies if the L1 cache is used. </summary> </member> <member name="F:Microsoft.Identity.Client.Cache.CacheLevel.L2Cache"> <summary> Specifies if the L2 cache is used. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.CacheSessionManager"> <summary> MSAL should only interact with the cache though this object. It is responsible for firing cache notifications. Flows should only perform (at most) 2 cache accesses: one to read data and one to write tokens. Reading data multiple times (e.g. read all ATs, read all RTs) should not refresh the cache from disk because of performance impact. Write operations are still the responsibility of TokenCache. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.CacheSessionManager.RefreshCacheForReadOperationsAsync"> <remarks> Possibly refreshes the internal cache by calling OnBeforeAccessAsync and OnAfterAccessAsync delegates. </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem.WithExpiresOn(System.DateTimeOffset)"> <summary> Creates a new object with a different expires on </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem.OboCacheKey"> <summary> Used to find the token in the cache. Can be a token assertion hash (normal OBO flow) or a user provided key (long-running OBO flow). </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem.KeyId"> <summary> Used when the token is bound to a public / private key pair which is identified by a key id (kid). Currently used by PoP tokens </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.Items.MsalAccountCacheItem"> <summary> Example account json: "authority_type":"MSSTS", "client_info":"", "environment":"login.windows.net", "family_name":"", "given_name":"Some Name", "home_account_id":"69c374a4-1df6-46f8-b83a-a2fcd8823ee2.49f548d0-12b7-4169-a390-bb5304d24462", "local_account_id":"69c374a4-1df6-46f8-b83a-a2fcd8823ee2", "middle_name":"", "name":"Some Name", "realm":"49f548d0-12b7-4169-a390-bb5304d24462", "username":"subzero@bogavrilltd.onmicrosoft.com", "wam_account_ids":"{\"00000000480FA373\":\"ob7b8h79td9gs6hfqoh2r37m\",\"4b0db8c2-9f26-4417-8bde-3f0e3656f8e0\":\"ob7b8h79td9gs6hfqoh2r37m\"}" </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAccountCacheItem.WamAccountIds"> <summary> WAM special implementation: MSA accounts (and also AAD accounts on UWP) cannot be discovered through WAM however the broker offers an interactive experience for the user to login, even with an MSA account. After an interactive login, MSAL must be able to silently login the MSA user. To do this, MSAL must save the account ID in its token cache. Accounts with associated WAM account ID can be used in silent WAM flows. </summary> </member> <member name="T:Microsoft.Identity.Client.Cache.Items.MsalAppMetadataCacheItem"> <summary> Apps shouldn't rely on its presence, unless the app itself wrote it. It means that SDK should translate absence of app metadata to the default values of its required fields. Other apps that don't support app metadata should never remove existing app metadata. App metadata is a non-removable entity.It means there's no need for a public API to remove app metadata, and it shouldn't be removed when removeAccount is called. App metadata is a non-secret entity. It means that it cannot store any secret information, like tokens, nor PII, like username etc. App metadata can be extended by adding additional fields when required.Absence of any non-required field should translate to default values for those field. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAppMetadataCacheItem.ClientId"> <remarks>mandatory</remarks> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAppMetadataCacheItem.Environment"> <remarks>mandatory</remarks> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalAppMetadataCacheItem.FamilyId"> <summary> The family id of which this application is part of. This is an internal feature and there is currently a single app, with id 1. If familyId is empty, it means an app is not part of a family. A missing entry means unknown status. </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.Items.MsalItemWithAdditionalFields.PopulateFieldsFromJObject(Microsoft.Identity.Json.Linq.JObject)"> <remarks> Important: order matters. This MUST be the last one called since it will extract the remaining fields out. </remarks> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalRefreshTokenCacheItem.FamilyId"> <summary> Optional. A value here means the token in an FRT. </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalRefreshTokenCacheItem.OboCacheKey"> <summary> Used to find the token in the cache. Can be a token assertion hash (normal OBO flow) or a user provided key (long-running OBO flow). </summary> </member> <member name="P:Microsoft.Identity.Client.Cache.Items.MsalRefreshTokenCacheItem.IsFRT"> <summary> Family Refresh Tokens, can be used for all clients part of the family </summary> </member> <member name="M:Microsoft.Identity.Client.Cache.ITokenCacheAccessor.GetAllAccessTokens(System.String,Microsoft.Identity.Client.Core.ILoggerAdapter)"> <summary> Returns all access tokens from the underlying cache collection. If <paramref name="optionalPartitionKey"/> is specified, returns access tokens from that partition only. </summary> <remarks> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. Not all classes that implement this method are required to filter by partition (e.g. mobile) </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.ITokenCacheAccessor.GetAllRefreshTokens(System.String,Microsoft.Identity.Client.Core.ILoggerAdapter)"> <summary> Returns all refresh tokens from the underlying cache collection. If <paramref name="optionalPartitionKey"/> is specified, returns refresh tokens from that partition only. </summary> <remarks> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. Not all classes that implement this method are required to filter by partition (e.g. mobile) </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.ITokenCacheAccessor.GetAllIdTokens(System.String,Microsoft.Identity.Client.Core.ILoggerAdapter)"> <summary> Returns all ID tokens from the underlying cache collection. If <paramref name="optionalPartitionKey"/> is specified, returns ID tokens from that partition only. </summary> <remarks> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. Not all classes that implement this method are required to filter by partition (e.g. mobile) </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.ITokenCacheAccessor.GetAllAccounts(System.String,Microsoft.Identity.Client.Core.ILoggerAdapter)"> <summary> Returns all accounts from the underlying cache collection. If <paramref name="optionalPartitionKey"/> is specified, returns accounts from that partition only. </summary> <remarks> WARNING: if partitionKey is null, this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. Not all classes that implement this method are required to filter by partition (e.g. mobile) </remarks> </member> <member name="M:Microsoft.Identity.Client.Cache.ITokenCacheAccessor.HasAccessOrRefreshTokens"> <remarks> WARNING: this API is slow as it loads all tokens, not just from 1 partition. It should only support external token caching, in the hope that the external token cache is partitioned. </remarks> </member> <member name="T:Microsoft.Identity.Client.Cache.TokenCacheDictionarySerializer"> <remarks> The dictionary serializer does not handle unknown nodes. </remarks> </member> <member name="T:Microsoft.Identity.Client.CacheRefreshReason"> <summary> Specifies the reason for fetching the access token from the identity provider when using AcquireTokenSilent, AcquireTokenForClient or AcquireTokenOnBehalfOf. </summary> </member> <member name="F:Microsoft.Identity.Client.CacheRefreshReason.NotApplicable"> <summary> When a token is found in the cache or the cache is not supposed to be hit when making the request (interactive call, username password call, device code flow, etc.) </summary> </member> <member name="F:Microsoft.Identity.Client.CacheRefreshReason.ForceRefreshOrClaims"> <summary> When the token request goes to the identity provider because force_refresh was set to true. Also occurs if WithClaims() is used. </summary> </member> <member name="F:Microsoft.Identity.Client.CacheRefreshReason.NoCachedAccessToken"> <summary> When the token request goes to the identity provider because no cached access token exists </summary> </member> <member name="F:Microsoft.Identity.Client.CacheRefreshReason.Expired"> <summary> When the token request goes to the identity provider because cached access token expired </summary> </member> <member name="F:Microsoft.Identity.Client.CacheRefreshReason.ProactivelyRefreshed"> <summary> When the token request goes to the identity provider because refresh_in was used and the existing token needs to be refreshed </summary> </member> <member name="T:Microsoft.Identity.Client.ClientApplicationBase"> <inheritdoc/> <inheritdoc/> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.AppConfig"> <summary> Details on the configuration of the ClientApplication for debugging purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.UserTokenCache"> <summary> User token cache. It holds access tokens, id tokens and refresh tokens for accounts. It's used and updated silently if needed when calling <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> or one of the overrides of <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/>. It is updated by each AcquireTokenXXX method, with the exception of <c>AcquireTokenForClient</c> which only uses the application cache (see <c>IConfidentialClientApplication</c>). </summary> <remarks>On .NET Framework and .NET Core you can also customize the token cache serialization. See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on mobile platforms and on UWP. It is recommended to use token cache serialization for web site and web api scenarios. </remarks> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.Authority"> <summary> Gets the URL of the authority, or security token service (STS) from which MSAL.NET will acquire security tokens The return value of this property is either the value provided by the developer in the constructor of the application, or otherwise the value of the <see cref="F:Microsoft.Identity.Client.ApplicationBase.DefaultAuthority"/> static member (that is <c>https://login.microsoftonline.com/common/</c>) </summary> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync"> <summary> Returns all the available <see cref="T:Microsoft.Identity.Client.IAccount">accounts</see> in the user token cache for the application. </summary> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync(System.Threading.CancellationToken)"> <summary> Returns all the available <see cref="T:Microsoft.Identity.Client.IAccount">accounts</see> in the user token cache for the application. </summary> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync(System.String)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> collection by its identifier among the accounts available in the token cache, based on the user flow. This is for Azure AD B2C scenarios. </summary> <param name="userFlow">The identifier is the user flow being targeted by the specific B2C authority/>. </param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync(System.String,System.Threading.CancellationToken)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> collection by its identifier among the accounts available in the token cache, based on the user flow. This is for Azure AD B2C scenarios. </summary> <param name="userFlow">The identifier is the user flow being targeted by the specific B2C authority/>. </param> <param name="cancellationToken">Cancellation token </param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountAsync(System.String,System.Threading.CancellationToken)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> by its identifier among the accounts available in the token cache. </summary> <param name="accountId">Account identifier. The identifier is typically the value of the <see cref="P:Microsoft.Identity.Client.AccountId.Identifier"/> property of <see cref="T:Microsoft.Identity.Client.AccountId"/>. You typically get the account id from an <see cref="T:Microsoft.Identity.Client.IAccount"/> by using the <see cref="P:Microsoft.Identity.Client.IAccount.HomeAccountId"/> property> </param> <param name="cancellationToken">Cancellation token </param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountAsync(System.String)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> by its identifier among the accounts available in the token cache. </summary> <param name="accountId">Account identifier. The identifier is typically the value of the <see cref="P:Microsoft.Identity.Client.AccountId.Identifier"/> property of <see cref="T:Microsoft.Identity.Client.AccountId"/>. You typically get the account id from an <see cref="T:Microsoft.Identity.Client.IAccount"/> by using the <see cref="P:Microsoft.Identity.Client.IAccount.HomeAccountId"/> property> </param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)"> <summary> Removes all tokens in the cache for the specified account. </summary> <param name="account">Instance of the account that needs to be removed</param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount,System.Threading.CancellationToken)"> <summary> Removes all tokens in the cache for the specified account. </summary> <param name="account">Instance of the account that needs to be removed</param> <param name="cancellationToken">Cancellation token</param> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> [V3 API] Attempts to acquire an access token for the <paramref name="account"/> from the user token cache. See https://aka.ms/msal-net-acquiretokensilent for more details </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested.</param> <returns>An <see cref="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder"/> used to build the token request, adding optional parameters</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">will be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache, or the user needs to consent, or re-sign-in (for instance if the password expired), or the user needs to perform two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned. If the access token is expired or close to expiration - within a 5 minute window - then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. You can set additional parameters by chaining the builder with: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"/> to request a token for a different authority than the one set at the application construction <see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)"/> to bypass the user token cache and force refreshing the token, as well as <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to specify extra query parameters </remarks> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> [V3 API] Attempts to acquire an access token for the <see cref="T:Microsoft.Identity.Client.IAccount"/> having the <see cref="P:Microsoft.Identity.Client.IAccount.Username" /> match the given <paramref name="loginHint"/>, from the user token cache. See https://aka.ms/msal-net-acquiretokensilent for more details </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Typically the username, in UPN format, e.g. johnd@contoso.com </param> <returns>An <see cref="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder"/> used to build the token request, adding optional parameters</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">will be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache, or the user needs to consent, or re-sign-in (for instance if the password expired), or the user needs to perform two factor authentication</exception> <remarks> If multiple <see cref="T:Microsoft.Identity.Client.IAccount"/> match the <paramref name="loginHint"/>, or if there are no matches, an exception is thrown. The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned. If the access token is expired or close to expiration - within a 5 minute window - then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. You can set additional parameters by chaining the builder with: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"/> to request a token for a different authority than the one set at the application construction <see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)"/> to bypass the user token cache and force refreshing the token, as well as <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to specify extra query parameters </remarks> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.Users"> <summary> In MSAL 1.x returned an enumeration of <see cref="T:Microsoft.Identity.Client.IUser"/>. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.GetUser(System.String)"> <summary> In MSAL 1.x, return a user from its identifier. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> <param name="identifier">Identifier of the user to retrieve</param> <returns>the user in the cache with the identifier passed as an argument</returns> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.Remove(Microsoft.Identity.Client.IUser)"> <summary> In MSAL 1.x removed a user from the cache. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> <param name="user">User to remove from the cache</param> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.Component"> <summary> Identifier of the component (libraries/SDK) consuming MSAL.NET. This will allow for disambiguation between MSAL usage by the app vs MSAL usage by component libraries. </summary> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.SliceParameters"> <summary> Sets or Gets a custom query parameters that may be sent to the STS for dogfood testing or debugging. This is a string of segments of the form <c>key=value</c> separated by an ampersand character. Unless requested otherwise, this parameter should not be set by application developers as it may have adverse effect on the application. </summary> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.ValidateAuthority"> <summary> Gets/sets a boolean value telling the application if the authority needs to be verified against a list of known authorities. The default value is <c>true</c>. It should currently be set to <c>false</c> for Azure AD B2C authorities as those are customer specific (a list of known B2C authorities cannot be maintained by MSAL.NET). This property can be set just after the construction of the application and before an operation acquiring a token or interacting with the STS. </summary> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.RedirectUri"> <summary> The redirect URI (also known as Reply URI or Reply URL), is the URI at which Azure AD will contact back the application with the tokens. This redirect URI needs to be registered in the app registration (https://aka.ms/msal-net-register-app). In MSAL.NET, <see cref="T:PublicClientApplication"/> define the following default RedirectUri values: <list type="bullet"> <item><description><c>https://login.microsoftonline.com/common/oauth2/nativeclient</c> for desktop (.NET Framework and .NET Core) applications</description></item> <item><description><c>msal{ClientId}</c> for Xamarin iOS and Xamarin Android (as this will be used by the system web browser by default on these platforms to call back the application) </description></item> </list> These default URIs could change in the future. In Microsoft.Identity.Client.ConfidentialClientApplication, this can be the URL of the web application / web API. </summary> <remarks>This is especially important when you deploy an application that you have initially tested locally; you then need to add the reply URL of the deployed application in the application registration portal</remarks> </member> <member name="P:Microsoft.Identity.Client.ClientApplicationBase.ClientId"> <summary> Gets the Client ID (also known as <i>Application ID</i>) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app) and as passed in the constructor of the application </summary> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,System.String,System.Boolean)"> <summary> [V2 API] Attempts to acquire an access token for the <paramref name="account"/> from the user token cache, with advanced parameters controlling network call. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount"/></param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured in the application constructor narrows down the selection to a specific tenant. This does not change the configured value in the application. This is specific to applications managing several accounts (like a mail client with several mailboxes)</param> <param name="forceRefresh">If <c>true</c>, ignore any access token in the cache and attempt to acquire new access token using the refresh token for the account if this one is available. This can be useful in the case when the application developer wants to make sure that conditional access policies are applied immediately, rather than after the expiration of the access token</param> <returns>An <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> containing the requested access token</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">can be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache,a or the user needs to consent, or re-sign-in (for instance if the password expired), or performs two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within a 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See https://aka.ms/msal-net-acquiretokensilent for more details </remarks> </member> <member name="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> [V2 API] Attempts to acquire an access token for the <paramref name="account"/> from the user token cache. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount"/></param> <returns>An <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> containing the requested token</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">can be thrown in the case where an interaction is required with the end user of the application, for instance so that the user consents, or re-signs-in (for instance if the password expired), or performs two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within a 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See https://aka.ms/msal-net-acquiretokensilent for more details </remarks> </member> <member name="T:Microsoft.Identity.Client.ConfidentialClientApplication"> <summary> Class to be used for confidential client applications (web apps, web APIs, and daemon applications). </summary> <remarks> Confidential client applications are typically applications which run on servers (web apps, web API, or even service/daemon applications). They are considered difficult to access, and therefore capable of keeping an application secret (hold configuration time secrets as these values would be difficult for end users to extract). A web app is the most common confidential client. The clientId is exposed through the web browser, but the secret is passed only in the back channel and never directly exposed. For details see https://aka.ms/msal-net-client-applications </remarks> </member> <member name="F:Microsoft.Identity.Client.ConfidentialClientApplication.AttemptRegionDiscovery"> <summary> Instructs MSAL to try to auto discover the Azure region. </summary> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenByAuthorizationCode(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Acquires a security token from the authority configured in the app using the authorization code previously received from the STS. It uses the OAuth 2.0 authorization code flow (See https://aka.ms/msal-net-authorization-code). It's usually used in web apps (for instance ASP.NET / ASP.NET Core web apps) which sign-in users, and can request an authorization code. This method does not lookup the token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/>. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="authorizationCode">The authorization code received from the service authorization endpoint.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can set optional parameters by chaining the builder with other .With methods. </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"> <summary> Acquires a token from the authority configured in the app, for the confidential client itself (in the name of no user) using the client credentials flow. See https://aka.ms/msal-net-client-credentials. </summary> <param name="scopes">scopes requested to access a protected API. For this flow (client credentials), the scopes of Microsoft APIs protected with AAD tokens are of the form "{ResourceIdUri/.default}". For example <c>https://management.azure.net/.default</c> or, for Microsoft Graph, <c>https://graph.microsoft.com/.default</c>. The requested scopes are defined statically with the application registration in the portal, and cannot be overridden in the application.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithForceRefresh(System.Boolean)"/> <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> Acquires an access token for this application (usually a Web API) from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. See https://aka.ms/msal-net-on-behalf-of. This confidential client application was itself called with a token which will be provided in the <paramref name="userAssertion">userAssertion</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable{System.String},System.String,System.String@)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.StopLongRunningProcessInWebApiAsync(System.String,System.Threading.CancellationToken)"> <summary> Stops an in progress long running OBO session by removing the tokens associated with the provided cache key. See https://aka.ms/msal-net-long-running-obo. </summary> <param name="longRunningProcessSessionKey">OBO cache key used to remove the tokens</param> <param name="cancellationToken">Cancellation token</param> <returns>Returns true if tokens are removed from the cache. False otherwise.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="longRunningProcessSessionKey"/> is not set.</exception> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.GetAuthorizationRequestUrl(System.Collections.Generic.IEnumerable{System.String})"> <summary> Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority configured in the application. This override enables you to specify a login hint and extra query parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>A builder enabling you to add optional parameters before executing the token request to get the URL of the STS authorization endpoint parametrized with the parameters</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithRedirectUri(System.String)"/> <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithLoginHint(System.String)"/> <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"/> </remarks> </member> <member name="P:Microsoft.Identity.Client.ConfidentialClientApplication.AppTokenCache"> <summary> Application token cache. This case holds access tokens for the application. It's maintained and updated silently if needed when calling <see cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"/> </summary> <remarks>On .NET Framework and .NET Core you can also customize the token cache serialization. See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on other platforms </remarks> </member> <member name="P:Microsoft.Identity.Client.ConfidentialClientApplication.Certificate"> <summary> The certificate used to create this <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>, if any. </summary> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.#ctor(System.String,System.String,Microsoft.Identity.Client.ClientCredential,Microsoft.Identity.Client.TokenCache,Microsoft.Identity.Client.TokenCache)"> <summary> [V2 API] Constructor for a confidential client application requesting tokens with the default authority (<see cref="F:Microsoft.Identity.Client.ApplicationBase.DefaultAuthority"/>) </summary> <param name="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)/. REQUIRED</param> <param name="redirectUri">URL where the STS will call back the application with the security token. REQUIRED</param> <param name="clientCredential">Credential, previously shared with Azure AD during the application registration and proving the identity of the application. An instance of ClientCredential can be created either from an application secret, or a certificate. REQUIRED.</param> <param name="userTokenCache">Token cache for saving user tokens. Can be set to null if the confidential client application only uses the Client Credentials grants (that is requests token in its own name and not in the name of users). Otherwise should be provided. REQUIRED</param> <param name="appTokenCache">Token cache for saving application (that is client token). Can be set to <c>null</c> except if the application uses the client credentials grants</param> <remarks> See https://aka.ms/msal-net-client-applications for a description of confidential client applications (and public client applications) Client credential grants are overrides of <see cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String})"/> See also <see cref="T:ConfidentialClientApplicationBuilder"/> for the V3 API way of building a confidential client application with a builder pattern. It offers building the application from configuration options, and a more fluid way of providing parameters. </remarks> <seealso cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> which enables app developers to specify the authority </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.#ctor(System.String,System.String,System.String,Microsoft.Identity.Client.ClientCredential,Microsoft.Identity.Client.TokenCache,Microsoft.Identity.Client.TokenCache)"> <summary> [V2 API] Constructor for a confidential client application requesting tokens with a specified authority </summary> <param name="clientId">Client ID (also named Application ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)/. REQUIRED</param> <param name="authority">Authority of the security token service (STS) from which MSAL.NET will acquire the tokens. Usual authorities are: <list type="bullet"> <item><description><c>https://login.microsoftonline.com/tenant/</c>, where <c>tenant</c> is the tenant ID of the Azure AD tenant or a domain associated with this Azure AD tenant, in order to sign-in users of a specific organization only</description></item> <item><description><c>https://login.microsoftonline.com/common/</c> to sign-in users with any work and school accounts or Microsoft personal accounts</description></item> <item><description><c>https://login.microsoftonline.com/organizations/</c> to sign-in users with any work and school accounts</description></item> <item><description><c>https://login.microsoftonline.com/consumers/</c> to sign-in users with only personal Microsoft accounts(live)</description></item> </list> Note that this setting needs to be consistent with what is declared in the application registration portal </param> <param name="redirectUri">URL where the STS will call back the application with the security token. REQUIRED</param> <param name="clientCredential">Credential, previously shared with Azure AD during the application registration and proving the identity of the application. An instance of <see cref="T:Microsoft.Identity.Client.ClientCredential"/> can be created either from an application secret, or a certificate. REQUIRED.</param> <param name="userTokenCache">Token cache for saving user tokens. Can be set to null if the confidential client application only uses the Client Credentials grants (that is requests token in its own name and not in the name of users). Otherwise should be provided. REQUIRED</param> <param name="appTokenCache">Token cache for saving application (that is client token). Can be set to <c>null</c> except if the application uses the client credentials grants</param> <remarks> See https://aka.ms/msal-net-client-applications for a description of confidential client applications (and public client applications) Client credential grants are overrides of <see cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String})"/> See also <see cref="T:ConfidentialClientApplicationBuilder"/> for the V3 API way of building a confidential client application with a builder pattern. It offers building the application from configuration options, and a more fluid way of providing parameters. </remarks> <seealso cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/> which enables app developers to create a confidential client application requesting tokens with the default authority. </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> [V2 API] Acquires an access token for this application (usually a web API) from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of). This confidential client application was itself called with a token which will be provided in the <paramref name="userAssertion">userAssertion</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)"/> for the on-behalf-of flow when specifying the authority <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> which is the corresponding V3 API. </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)"> <summary> [V2 API] Acquires an access token for this application (usually a web API) from a specific authority, in order to access another downstream protected web API on behalf of a user (See https://aka.ms/msal-net-on-behalf-of). This confidential client application was itself called with a token which will be provided in the <paramref name="userAssertion">userAssertion</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> for the on-behalf-of flow without specifying the authority <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> which is the corresponding V3 API. </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.Microsoft#Identity#Client#IConfidentialClientApplicationWithCertificate#AcquireTokenOnBehalfOfWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> [V2 API] Acquires an access token for this application (usually a web API) from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of). This confidential client application was itself called with a token which will be provided in the <paramref name="userAssertion">userAssertion</paramref> parameter. This override sends the certificate, which helps certificate rotation in Azure AD </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.Microsoft#Identity#Client#IConfidentialClientApplicationWithCertificate#AcquireTokenOnBehalfOfWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)"> <summary> [V2 API] Acquires an access token for this application (usually a web API) from a specific authority, in order to access another downstream protected web API on behalf of a user (See https://aka.ms/msal-net-on-behalf-of). This confidential client application was itself called with a token which will be provided in the This override sends the certificate, which helps certificate rotation in Azure AD <paramref name="userAssertion">userAssertion</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenByAuthorizationCodeAsync(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> [V2 API] Acquires a security token from the authority configured in the app using the authorization code previously received from the STS. It uses the OAuth 2.0 authorization code flow (See https://aka.ms/msal-net-authorization-code). It's usually used in web apps (for instance ASP.NET / ASP.NET Core web apps) which sign-in users, and therefore receive an authorization code. This method does not lookup the token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/>. </summary> <param name="authorizationCode">The authorization code received from service authorization endpoint.</param> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing token of the user for the requested scopes</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenByAuthorizationCode(System.Collections.Generic.IEnumerable{System.String},System.String)"/> which is the corresponding V2 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V3 API] Acquires a token from the authority configured in the app, for the confidential client itself (in the name of no user) using the client credentials flow. (See https://aka.ms/msal-net-client-credentials) </summary> <param name="scopes">scopes requested to access a protected API. For this flow (client credentials), the scopes should be of the form "{ResourceIdUri/.default}" for instance <c>https://management.azure.net/.default</c> or, for Microsoft Graph, <c>https://graph.microsoft.com/.default</c> as the requested scopes are really defined statically at application registration in the portal, and cannot be overridden in the application. See also </param> <returns>Authentication result containing the token of the user for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String},System.Boolean)"> <summary> [V2 API] Acquires a token from the authority configured in the app, for the confidential client itself (in the name of no user) using the client credentials flow. (See https://aka.ms/msal-net-client-credentials) </summary> <param name="scopes">Scopes requested to access a protected API. For this flow (client credentials), the scopes should be of the form "{ResourceIdUri/.default}" for instance <c>https://management.azure.net/.default</c> or, for Microsoft Graph, <c>https://graph.microsoft.com/.default</c> as the requested scopes are really defined statically at application registration in the portal, and cannot be overridden in the application</param> <param name="forceRefresh">If <c>true</c>, API will ignore the access token in the cache and attempt to acquire new access token using client credentials. This override can be used in case the application knows that conditional access policies changed</param> <returns>Authentication result containing token of the user for the requested scopes</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.Microsoft#Identity#Client#IConfidentialClientApplicationWithCertificate#AcquireTokenForClientWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V2 API] Acquires token from the service for the confidential client using the client credentials flow. (See https://aka.ms/msal-net-client-credentials) This method enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation) </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing application token for the requested scopes</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.Microsoft#Identity#Client#IConfidentialClientApplicationWithCertificate#AcquireTokenForClientWithCertificateAsync(System.Collections.Generic.IEnumerable{System.String},System.Boolean)"> <summary> [V2 API] Acquires token from the service for the confidential client using the client credentials flow. (See https://aka.ms/msal-net-client-credentials) This method attempts to look up valid access token in the cache unless<paramref name="forceRefresh"/> is true This method enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the public certificate to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation) </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="forceRefresh">If TRUE, API will ignore the access token in the cache and attempt to acquire new access token using client credentials</param> <returns>Authentication result containing application token for the requested scopes</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.Microsoft#Identity#Client#IByRefreshToken#AcquireTokenByRefreshTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Acquires an access token from an existing refresh token and stores it and the refresh token into the application user token cache, where it will be available for further AcquireTokenSilentAsync calls. This method can be used in migration to MSAL from ADAL v2 and in various integration scenarios where you have a RefreshToken available. (see https://aka.ms/msal-net-migration-adal2-msal2) </summary> <param name="scopes">Scope to request from the token endpoint. Setting this to null or empty will request an access token, refresh token and ID token with default scopes</param> <param name="refreshToken">The refresh token (for example previously obtained from ADAL 2.x)</param> </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.GetAuthorizationRequestUrlAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"> <summary> [V2 API] Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority configured in the application. This override enables you to specify a login hint and extra query parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally a UPN. This can be empty</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>URL of the authorize endpoint including the query parameters.</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.GetAuthorizationRequestUrl(System.Collections.Generic.IEnumerable{System.String})"/> which is the corresponding V3 API </member> <member name="M:Microsoft.Identity.Client.ConfidentialClientApplication.GetAuthorizationRequestUrlAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> [V2 API] Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority specified as the <paramref name="authority"/> parameter. This override enables you to specify a redirectUri, login hint extra query parameters, extra scope to consent (which are not for the same resource as the <paramref name="scopes"/>), and an authority. </summary> <param name="scopes">Scopes requested to access a protected API (a resource)</param> <param name="redirectUri">Address to return to upon receiving a response from the authority.</param> <param name="loginHint">Identifier of the user. Generally a UPN.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes for additional resources (other than the resource for which <paramref name="scopes"/> are requested), which a developer can request the user to consent to upfront.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>URL of the authorize endpoint including the query parameters.</returns> <seealso cref="M:Microsoft.Identity.Client.ConfidentialClientApplication.GetAuthorizationRequestUrl(System.Collections.Generic.IEnumerable{System.String})"/> which is the corresponding V3 API </member> <member name="T:Microsoft.Identity.Client.DeviceCodeResult"> <summary> This object is returned as part of the device code flow and has information intended to be shown to the user about where to navigate to login and what the device code needs to be entered on that device. See https://aka.ms/msal-device-code-flow. </summary> <seealso cref="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenWithDeviceCode(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> and the other overrides </seealso> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.UserCode"> <summary> User code returned by the service </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.DeviceCode"> <summary> Device code returned by the service </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.VerificationUrl"> <summary> Verification URL where the user must navigate to authenticate using the device code and credentials. </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.ExpiresOn"> <summary> Time when the device code will expire. </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.Interval"> <summary> Polling interval time to check for completion of authentication flow. </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.Message"> <summary> User friendly text response that can be used for display purpose. </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.ClientId"> <summary> Identifier of the client requesting device code. </summary> </member> <member name="P:Microsoft.Identity.Client.DeviceCodeResult.Scopes"> <summary> List of the scopes that would be held by token. </summary> </member> <member name="T:Microsoft.Identity.Client.Extensibility.AbstractConfidentialClientAcquireTokenParameterBuilderExtension"> <summary> Extensions for <see cref="T:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder"/> </summary> </member> <member name="M:Microsoft.Identity.Client.Extensibility.AbstractConfidentialClientAcquireTokenParameterBuilderExtension.OnBeforeTokenRequest``1(Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder{``0},System.Func{Microsoft.Identity.Client.Extensibility.OnBeforeTokenRequestData,System.Threading.Tasks.Task})"> <summary> Intervenes in the request pipeline, by executing a user provided delegate before MSAL makes the token request. The delegate can modify the request payload by adding or removing body parameters and headers. <see cref="T:Microsoft.Identity.Client.Extensibility.OnBeforeTokenRequestData"/> </summary> <typeparam name="T"></typeparam> <param name="builder">The builder to chain options to</param> <param name="onBeforeTokenRequestHandler">An async delegate which gets invoked just before MSAL makes a token request</param> <returns>The builder to chain other options to.</returns> </member> <member name="T:Microsoft.Identity.Client.Extensibility.AcquireTokenForClientBuilderExtensions"> <summary> Extensions for <see cref="T:Microsoft.Identity.Client.Extensibility.AcquireTokenForClientBuilderExtensions"/> class </summary> </member> <member name="M:Microsoft.Identity.Client.Extensibility.AcquireTokenForClientBuilderExtensions.WithProofOfPosessionKeyId(Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder,System.String,System.String)"> <summary> Binds the token to a key in the cache. L2 cache keys contain the key id. No cryptographic operations is performed on the token. </summary> <param name="builder"></param> <param name="keyId">A key id to which the access token is associated. The token will not be retrieved from the cache unless the same key id is presented. Can be null.</param> <param name="expectedTokenTypeFromAad">AAD issues several types of bound tokens. MSAL checks the token type, which needs to match the value set by ESTS. Normal POP tokens have this as "pop"</param> <returns>the builder</returns> </member> <member name="T:Microsoft.Identity.Client.Extensibility.AcquireTokenInteractiveParameterBuilderExtensions"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Extensibility.AcquireTokenInteractiveParameterBuilderExtensions.WithCustomWebUi(Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder,Microsoft.Identity.Client.Extensibility.ICustomWebUi)"> <summary> Extension method enabling MSAL.NET extenders for public client applications to set a custom web UI that will let the user sign-in with Azure AD, present consent if needed, and get back the authorization code </summary> <param name="builder">Builder for an AcquireTokenInteractive</param> <param name="customWebUi">Customer implementation for the Web UI</param> <returns>the builder to be able to chain .With methods</returns> </member> <member name="T:Microsoft.Identity.Client.Extensibility.AcquireTokenOnBehalfOfParameterBuilderExtensions"> <summary> Extension methods for the <see cref="T:Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder" /> </summary> </member> <member name="M:Microsoft.Identity.Client.Extensibility.AcquireTokenOnBehalfOfParameterBuilderExtensions.WithSearchInCacheForLongRunningProcess(Microsoft.Identity.Client.AcquireTokenOnBehalfOfParameterBuilder,System.Boolean)"> <summary> Only affects <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable{System.String},System.String,System.String@)"/>. When enabled, mimics MSAL 4.50.0 and below behavior - checks in cache for cached tokens first, and if not found, then uses user assertion to request new tokens from AAD. When disabled (default behavior), doesn't search in cache, but uses the user assertion to retrieve tokens from AAD. </summary> <remarks> This method should only be used in specific cases for backwards compatibility. For most cases, rely on the default behavior of <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable{System.String},System.String,System.String@)"/> and <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)"/> described in https://aka.ms/msal-net-long-running-obo . </remarks> <param name="builder"></param> <param name="searchInCache">Whether to search in cache.</param> <returns>The builder to chain the .With methods</returns> </member> <member name="T:Microsoft.Identity.Client.Extensibility.AppTokenProviderParameters"> <summary> The authentication parameters provided to the app token provider callback. </summary> </member> <member name="P:Microsoft.Identity.Client.Extensibility.AppTokenProviderParameters.Scopes"> <summary> Specifies which scopes to request. </summary> </member> <member name="P:Microsoft.Identity.Client.Extensibility.AppTokenProviderParameters.CorrelationId"> <summary> Correlation id of the authentication request. </summary> </member> <member name="P:Microsoft.Identity.Client.Extensibility.AppTokenProviderParameters.Claims"> <summary> A string with one or multiple claims. </summary> </member> <member name="P:Microsoft.Identity.Client.Extensibility.AppTokenProviderParameters.TenantId"> <summary> Tenant id of the </summary> </member> <member name="P:Microsoft.Identity.Client.Extensibility.AppTokenProviderParameters.CancellationToken"> <summary> Used to cancel the authentication attempt made by the token provider </summary> </member> <member name="T:Microsoft.Identity.Client.Extensibility.AppTokenProviderResult"> <summary> Token result from external app token provider </summary> <remarks> This is part of an extensibility mechanism designed to be used by Azure SDK in order to enhance managed identity support. </remarks> </member> <member name="P:Microsoft.Identity.Client.Extensibility.AppTokenProviderResult.AccessToken"> <summary> The actual token, ussually in JWT format </summary> </member> <member name="P:Microsoft.Identity.Client.Extensibility.AppTokenProviderResult.ExpiresInSeconds"> <summary> Expiration of token </summary> <remarks>Mandatory</remarks> </member> <member name="P:Microsoft.Identity.Client.Extensibility.AppTokenProviderResult.RefreshInSeconds"> <summary> When the token should be refreshed. </summary> <remarks>If not set, MSAL will set it to half of the expiry time if that time is longer than 2 hours.</remarks> </member> <member name="T:Microsoft.Identity.Client.Extensibility.ConfidentialClientApplicationBuilderExtensions"> <summary> Extensibility methods for <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplicationBuilder"/> </summary> </member> <member name="M:Microsoft.Identity.Client.Extensibility.ConfidentialClientApplicationBuilderExtensions.WithAppTokenProvider(Microsoft.Identity.Client.ConfidentialClientApplicationBuilder,System.Func{Microsoft.Identity.Client.Extensibility.AppTokenProviderParameters,System.Threading.Tasks.Task{Microsoft.Identity.Client.Extensibility.AppTokenProviderResult}})"> <summary> Allows setting a callback which returns an access token, based on the passed-in parameters. MSAL will pass in its authentication parameters to the callback and it is expected that the callback will construct a <see cref="T:Microsoft.Identity.Client.Extensibility.AppTokenProviderResult"/> and return it to MSAL. MSAL will cache the token response the same way it does for other authentication results. </summary> <remarks>This is part of an extensibility mechanism designed to be used only by Azure SDK in order to enchance managed identity support. Only client_credential flow is supported.</remarks> </member> <member name="T:Microsoft.Identity.Client.Extensibility.ConfidentialClientApplicationExtensions"> <summary> Extensibility methods for <see cref="T:Microsoft.Identity.Client.IConfidentialClientApplication"/> </summary> </member> <member name="M:Microsoft.Identity.Client.Extensibility.ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync(Microsoft.Identity.Client.ILongRunningWebApi,System.String,System.Threading.CancellationToken)"> <summary> Stops an in progress long running OBO session by removing the tokens associated with the provided cache key. See https://aka.ms/msal-net-long-running-obo. </summary> <param name="clientApp">Client app to remove tokens from</param> <param name="longRunningProcessSessionKey">OBO cache key used to remove the tokens</param> <param name="cancellationToken">Cancellation token</param> <returns>Returns true if tokens are removed from the cache. False otherwise.</returns> <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="longRunningProcessSessionKey"/> is not set.</exception> </member> <member name="T:Microsoft.Identity.Client.Extensibility.ICustomWebUi"> <summary> Interface that an MSAL.NET extender can implement to provide their own web UI in public client applications to sign-in user and have them consented part of the Authorization code flow. MSAL.NET provides an embedded web view for Windows and Mac, but there are other scenarios not yet supported. This extensibility point enables them to provide such UI in a secure way </summary> </member> <member name="M:Microsoft.Identity.Client.Extensibility.ICustomWebUi.AcquireAuthorizationCodeAsync(System.Uri,System.Uri,System.Threading.CancellationToken)"> <summary> Method called by MSAL.NET to delegate the authentication code web with the Secure Token Service (STS) </summary> <param name="authorizationUri"> URI computed by MSAL.NET that will let the UI extension navigate to the STS authorization endpoint in order to sign-in the user and have them consent </param> <param name="redirectUri">The redirect URI that was configured. The auth code will be appended to this redirect URI and the browser will redirect to it. </param> <param name="cancellationToken">The cancellation token to which you should respond to. See https://docs.microsoft.com/en-us/dotnet/standard/parallel-programming/task-cancellation for details. </param> <returns> The URI returned back from the STS authorization endpoint. This URI contains a code=CODE parameters that MSAL.NET will extract and redeem. </returns> <remarks> The <paramref name="authorizationUri">authorizationUri</paramref>"/> is crafted to leverage PKCE in order to protect the token from a man in the middle attack. Only MSAL.NET can redeem the code. In the event of cancellation, the implementer should return OperationCanceledException. </remarks> </member> <member name="T:Microsoft.Identity.Client.Extensibility.OnBeforeTokenRequestData"> <summary> Authentication request details </summary> </member> <member name="M:Microsoft.Identity.Client.Extensibility.OnBeforeTokenRequestData.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},System.Uri,System.Threading.CancellationToken)"> <summary> Constructor. </summary> <remarks>Apps should not have to use this constructor. It is provided for testability purposes.</remarks> </member> <member name="P:Microsoft.Identity.Client.Extensibility.OnBeforeTokenRequestData.BodyParameters"> <summary> Parameters which will be sent in the request body, as POST parameters. </summary> </member> <member name="P:Microsoft.Identity.Client.Extensibility.OnBeforeTokenRequestData.Headers"> <summary> Headers which will be sent with the request. </summary> </member> <member name="P:Microsoft.Identity.Client.Extensibility.OnBeforeTokenRequestData.RequestUri"> <summary> The token endpoint, including any query parameters, where the request is being sent to. </summary> </member> <member name="P:Microsoft.Identity.Client.Extensibility.OnBeforeTokenRequestData.CancellationToken"> <summary> The cancellation token associated with the request </summary> </member> <member name="T:Microsoft.Identity.Client.Advanced.AcquireTokenParameterBuilderExtensions"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.Advanced.AcquireTokenParameterBuilderExtensions.WithExtraHttpHeaders``1(Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder{``0},System.Collections.Generic.IDictionary{System.String,System.String})"> <summary> Adds additional Http Headers to the token request. </summary> <param name="builder">Parameter builder for a acquiring tokens.</param> <param name="extraHttpHeaders">additional Http Headers to add to the token request.</param> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.PublicClientApplicationExtensions"> <summary> Extensibility methods for <see cref="T:Microsoft.Identity.Client.IPublicClientApplication"/> </summary> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplicationExtensions.IsProofOfPossessionSupportedByClient(Microsoft.Identity.Client.IPublicClientApplication)"> <summary> Used to determine if the currently available broker is able to perform Proof-of-Possession. </summary> <returns>Boolean indicating if Proof-of-Possession is supported</returns> </member> <member name="T:Microsoft.Identity.Client.SSHCertificates.SSHExtensions"> <summary> Extensions that add support for SSH certificates </summary> </member> <member name="M:Microsoft.Identity.Client.SSHCertificates.SSHExtensions.WithSSHCertificateAuthenticationScheme(Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder,System.String,System.String)"> <summary> Instructs AAD to return an SSH certificate instead of a Bearer token. The SSH certificate (not the same as public / private key pair used by SSH), can be used to securely deploy a public SSH key to a machine. See https://aka.ms/msal-net-ssh for details. </summary> <param name="builder">Interactive authentication builder</param> <param name="publicKeyJwk">The public SSH key in JWK format (https://tools.ietf.org/html/rfc7517). Currently only RSA is supported, and the JWK should contain only the RSA modulus and exponent</param> <param name="keyId">A key identifier, it can be in any format. Used to distinguish between different keys when fetching an SSH certificate from the token cache.</param> </member> <member name="M:Microsoft.Identity.Client.SSHCertificates.SSHExtensions.WithSSHCertificateAuthenticationScheme(Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder,System.String,System.String)"> <summary> Instructs AAD to return an SSH certificate instead of a Bearer token. Attempts to retrieve the certificate from the token cache, and if one is not found, attempts to acquire one silently, using the refresh token. See https://aka.ms/msal-net-ssh for details. </summary> <remarks> The same keyID must be used to distinguish between various </remarks> <param name="builder">Silent authentication builder</param> <param name="publicKeyJwk">The public SSH key in JWK format (https://tools.ietf.org/html/rfc7517). Currently only RSA is supported, and the JWK should contain only the RSA modulus and exponent</param> <param name="keyId"></param> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.Http.HttpManager"> <remarks> We invoke this class from different threads and they all use the same HttpClient. To prevent race conditions, make sure you do not get / set anything on HttpClient itself, instead rely on HttpRequest objects which are thread specific. In particular, do not change any properties on HttpClient such as BaseAddress, buffer sizes and Timeout. You should also not access DefaultRequestHeaders because the getters are not thread safe (use HttpRequestMessage.Headers instead). </remarks> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManager.SendGetForceResponseAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},Microsoft.Identity.Client.Core.ILoggerAdapter,System.Boolean,System.Threading.CancellationToken)"> <summary> Performs the GET request just like <see cref="M:Microsoft.Identity.Client.Http.HttpManager.SendGetAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},Microsoft.Identity.Client.Core.ILoggerAdapter,System.Boolean,System.Threading.CancellationToken)"/> but does not throw a ServiceUnavailable service exception. Instead, it returns the <see cref="T:Microsoft.Identity.Client.Http.HttpResponse"/> associated with the request. </summary> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManager.SendPostForceResponseAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},Microsoft.Identity.Client.Core.ILoggerAdapter,System.Threading.CancellationToken)"> <summary> Performs the POST request just like <see cref="M:Microsoft.Identity.Client.Http.HttpManager.SendPostAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},Microsoft.Identity.Client.Core.ILoggerAdapter,System.Threading.CancellationToken)"/> but does not throw a ServiceUnavailable service exception. Instead, it returns the <see cref="T:Microsoft.Identity.Client.Http.HttpResponse"/> associated with the request. </summary> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManager.SendPostForceResponseAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Net.Http.StringContent,Microsoft.Identity.Client.Core.ILoggerAdapter,System.Threading.CancellationToken)"> <summary> Performs the POST request just like <see cref="M:Microsoft.Identity.Client.Http.HttpManager.SendPostAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Net.Http.HttpContent,Microsoft.Identity.Client.Core.ILoggerAdapter,System.Threading.CancellationToken)"/> but does not throw a ServiceUnavailable service exception. Instead, it returns the <see cref="T:Microsoft.Identity.Client.Http.HttpResponse"/> associated with the request. </summary> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManager.IsRetryableStatusCode(System.Int32)"> <summary> In HttpManager, the retry policy is based on this simple condition. Avoid changing this, as it's breaking change. </summary> </member> <member name="T:Microsoft.Identity.Client.Http.HttpManagerFactory"> <summary> Factory to return the instance of HttpManager based on retry configuration and type of MSAL application. </summary> </member> <member name="T:Microsoft.Identity.Client.Http.HttpManagerManagedIdentity"> <remarks> HTTP Manager specific to managed identity to implement the retry for specific HTTP status codes. </remarks> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManagerManagedIdentity.IsRetryableStatusCode(System.Int32)"> <summary> Retry policy specific to managed identity flow. Avoid changing this, as it's breaking change. </summary> </member> <member name="T:Microsoft.Identity.Client.Http.HttpManagerWithRetry"> <remarks> We invoke this class from different threads and they all use the same HttpClient. To prevent race conditions, make sure you do not get / set anything on HttpClient itself, instead rely on HttpRequest objects which are thread specific. In particular, do not change any properties on HttpClient such as BaseAddress, buffer sizes and Timeout. You should also not access DefaultRequestHeaders because the getters are not thread safe (use HttpRequestMessage.Headers instead). </remarks> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManagerWithRetry.SendPostAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Net.Http.HttpContent,Microsoft.Identity.Client.Core.ILoggerAdapter,System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManagerWithRetry.SendGetAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},Microsoft.Identity.Client.Core.ILoggerAdapter,System.Boolean,System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManagerWithRetry.SendGetForceResponseAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},Microsoft.Identity.Client.Core.ILoggerAdapter,System.Boolean,System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManagerWithRetry.SendPostForceResponseAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Collections.Generic.IDictionary{System.String,System.String},Microsoft.Identity.Client.Core.ILoggerAdapter,System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.Http.HttpManagerWithRetry.SendPostForceResponseAsync(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Net.Http.StringContent,Microsoft.Identity.Client.Core.ILoggerAdapter,System.Threading.CancellationToken)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.Http.RedirectUriHelper.Validate(System.Uri,System.Boolean)"> <summary> Check common redirect URI problems. Optionally check that the redirect URI is not the OAuth2 standard redirect URI https://login.microsoftonline.com/common/oauth2/nativeclientb when using a system browser, because the browser cannot redirect back to the app. </summary> </member> <member name="T:Microsoft.Identity.Client.IAccount"> <summary> The IAccount interface represents information about a single account. The same user can be present in different tenants, that is, a user can have multiple accounts. An <c>IAccount</c> is returned in the <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/>.<see cref="P:Microsoft.Identity.Client.AuthenticationResult.Account"/> property, and can be used as parameters of PublicClientApplication and ConfidentialClientApplication methods acquiring tokens such as <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> </summary> </member> <member name="P:Microsoft.Identity.Client.IAccount.Username"> <summary> Gets a string containing the displayable value in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c>. This can be null. </summary> <remarks>This property replaces the <c>DisplayableId</c> property of <c>IUser</c> in previous versions of MSAL.NET</remarks> </member> <member name="P:Microsoft.Identity.Client.IAccount.Environment"> <summary> Gets a string containing the identity provider for this account, e.g. <c>login.microsoftonline.com</c>. </summary> <remarks>This property replaces the <c>IdentityProvider</c> property of <c>IUser</c> in previous versions of MSAL.NET except that IdentityProvider was a URL with information about the tenant (in addition to the cloud environment), whereas Environment is only the <see cref="P:System.Uri.Host"/></remarks> </member> <member name="P:Microsoft.Identity.Client.IAccount.HomeAccountId"> <summary> AccountId of the home account for the user. This uniquely identifies the user across AAD tenants. </summary> <remarks>Can be null, for example if this account was migrated to MSAL.NET from ADAL.NET v3's token cache</remarks> </member> <member name="T:Microsoft.Identity.Client.IApplicationBase"> <summary> Interface used for creation of client applications. For details see https://aka.ms/msal-net-client-applications. </summary> </member> <member name="T:Microsoft.Identity.Client.IByRefreshToken"> <summary> </summary> </member> <member name="M:Microsoft.Identity.Client.IByRefreshToken.AcquireTokenByRefreshToken(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Acquires an access token from an existing refresh token and stores it, and the refresh token, in the user token cache, where it will be available for further AcquireTokenSilent calls. This method can be used in migration to MSAL from ADAL v2, and in various integration scenarios where you have a RefreshToken available. See https://aka.ms/msal-net-migration-adal2-msal2. </summary> <param name="scopes">Scope to request from the token endpoint. Setting this to null or empty will request an access token, refresh token and ID token with default scopes</param> <param name="refreshToken">The refresh token from ADAL 2.x</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> </member> <member name="M:Microsoft.Identity.Client.IByRefreshToken.AcquireTokenByRefreshTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Acquires an access token from an existing refresh token and stores it and the refresh token into the user token cache, where it will be available for further AcquireTokenSilentAsync calls. This method can be used in migration to MSAL from ADAL v2 and in various integration scenarios where you have a RefreshToken available. (see https://aka.ms/msal-net-migration-adal2-msal2) </summary> <param name="scopes">Scope to request from the token endpoint. Setting this to null or empty will request an access token, refresh token and ID token with default scopes</param> <param name="refreshToken">The refresh token from ADAL 2.x</param> </member> <member name="T:Microsoft.Identity.Client.IClientApplicationBase"> <inheritdoc/> <summary> Interface defining common API methods and properties. Both <see cref="T:PublicClientApplication"/> and <see cref="T:ConfidentialClientApplication"/> extend this class. For details see https://aka.ms/msal-net-client-applications </summary> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.AppConfig"> <summary> Details on the configuration of the ClientApplication for debugging purposes. </summary> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.UserTokenCache"> <summary> User token cache. This case holds id tokens, access tokens and refresh tokens for accounts. It's used and updated silently if needed when calling <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> It is updated by each AcquireTokenXXX method, with the exception of <c>AcquireTokenForClient</c> which only uses the application cache (see <c>IConfidentialClientApplication</c>). </summary> <remarks>On .NET Framework and .NET Core you can also customize the token cache serialization. See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on other platforms. </remarks> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.Authority"> <summary> Gets the URL of the authority, or the security token service (STS) from which MSAL.NET will acquire security tokens. The return value of this property is either the value provided by the developer in the constructor of the application, or otherwise the value of the <see cref="P:Microsoft.Identity.Client.ClientApplicationBase.Authority"/> static member (that is <c>https://login.microsoftonline.com/common/</c>) </summary> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync"> <summary> Returns all the available <see cref="T:Microsoft.Identity.Client.IAccount">accounts</see> in the user token cache for the application. </summary> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountAsync(System.String)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> by its identifier among the accounts available in the token cache and of the same environment (authority host) as <see cref="P:Microsoft.Identity.Client.IClientApplicationBase.Authority"/> </summary> <param name="identifier">Account identifier. The value of the identifier will probably have been stored value from the value of the <see cref="P:Microsoft.Identity.Client.AccountId.Identifier"/> property of <see cref="T:Microsoft.Identity.Client.AccountId"/>. You typically get the account id from an <see cref="T:Microsoft.Identity.Client.IAccount"/> by using the <see cref="P:Microsoft.Identity.Client.IAccount.HomeAccountId"/> property></param> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync(System.String)"> <summary> Get the <see cref="T:Microsoft.Identity.Client.IAccount"/> collection by its identifier among the accounts available in the token cache, based on the user flow. This is for Azure AD B2C scenarios. </summary> <param name="userFlow">The identifier is the user flow being targeted by the specific B2C authority/>. </param> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> Attempts to acquire an access token for the <paramref name="account"/> from the user token cache, with advanced parameters controlling the network call. See https://aka.ms/msal-net-acquiretokensilent for more details </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount"/></param> <returns>An <see cref="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder"/> used to build the token request, adding optional parameters</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">will be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache,a or the user needs to consent, or re-sign-in (for instance if the password expired), or the user needs to perform two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within a 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See also the additional parameters that you can set chain: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"/> to request a token for a different authority than the one set at the application construction <see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)"/> to bypass the user token cache and force refreshing the token, as well as <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to specify extra query parameters </remarks> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Attempts to acquire an access token for the <paramref name="loginHint"/> from the user token cache, with advanced parameters controlling the network call. See https://aka.ms/msal-net-acquiretokensilent for more details </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Typically the username, in UPN format, e.g. johnd@contoso.com </param> <returns>An <see cref="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder"/> used to build the token request, adding optional parameters</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">will be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache,a or the user needs to consent, or re-sign-in (for instance if the password expired), or the user needs to perform two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within a 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See also the additional parameters that you can set chain: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)"/> to request a token for a different authority than the one set at the application construction <see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)"/> to bypass the user token cache and force refreshing the token, as well as <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to specify extra query parameters </remarks> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)"> <summary> Removes all tokens in the cache for the specified account. </summary> <param name="account">instance of the account that needs to be removed</param> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.Users"> <summary> In MSAL 1.x returned an enumeration of <see cref="T:Microsoft.Identity.Client.IUser"/>. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.GetUser(System.String)"> <summary> In MSAL 1.x, return a user from its identifier. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> <param name="identifier">Identifier of the user to retrieve</param> <returns>the user in the cache with the identifier passed as an argument</returns> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.Remove(Microsoft.Identity.Client.IUser)"> <summary> In MSAL 1.x removed a user from the cache. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> <param name="user">User to remove from the cache</param> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.Component"> <summary> Identifier of the component (libraries/SDK) consuming MSAL.NET. This will allow for disambiguation between MSAL usage by the app vs MSAL usage by component libraries. </summary> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.SliceParameters"> <summary> Sets or Gets a custom query parameters that may be sent to the STS for dogfood testing or debugging. This is a string of segments of the form <c>key=value</c> separated by an ampersand character. Unless requested otherwise, this parameter should not be set by application developers as it may have adverse effect on the application. </summary> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.ValidateAuthority"> <summary> Gets a boolean value telling the application if the authority needs to be verified against a list of known authorities. The default value is <c>true</c>. It should currently be set to <c>false</c> for Azure AD B2C authorities as those are customer specific (a list of known B2C authorities cannot be maintained by MSAL.NET) </summary> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.RedirectUri"> <summary> The redirect URI (also known as Reply URI or Reply URL), is the URI at which Azure AD will contact back the application with the tokens. This redirect URI needs to be registered in the app registration (https://aka.ms/msal-net-register-app) In MSAL.NET, <see cref="T:PublicClientApplication"/> define the following default RedirectUri values: <list type="bullet"> <item><description><c>urn:ietf:wg:oauth:2.0:oob</c> for desktop (.NET Framework and .NET Core) applications</description></item> <item><description><c>msal{ClientId}</c> for Xamarin iOS and Xamarin Android (as this will be used by the system web browser by default on these platforms to call back the application) </description></item> </list> These default URIs could change in the future. In <see cref="T:Microsoft.Identity.Client.ConfidentialClientApplication"/>, this can be the URL of the web application / web API. </summary> <remarks>This is especially important when you deploy an application that you have initially tested locally; you then need to add the reply URL of the deployed application in the application registration portal. </remarks> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> Attempts to acquire an access token for the <paramref name="account"/> from the user token cache. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount"/></param> <returns>An <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> containing the requested token</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">can be thrown in the case where an interaction is required with the end user of the application, for instance so that the user consents, or re-signs-in (for instance if the password expired), or performs two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See https://aka.ms/msal-net-acuiretokensilent for more details </remarks> </member> <member name="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,System.String,System.Boolean)"> <summary> Attempts to acquire and access token for the <paramref name="account"/> from the user token cache, with advanced parameters making a network call. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount"/></param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured in the application constructor narrows down the selection of tenants for which to get a tenant, but does not change the configured value</param> <param name="forceRefresh">If <c>true</c>, the will ignore the access token in the cache and attempt to acquire new access token using the refresh token for the account if this one is available. This can be useful in the case when the application developer wants to make sure that conditional access policies are applies immediately, rather than after the expiration of the access token</param> <returns>An <see cref="T:Microsoft.Identity.Client.AuthenticationResult"/> containing the requested token</returns> <exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">can be thrown in the case where an interaction is required with the end user of the application, for instance, if no refresh token was in the cache, or the user needs to consents, or re-sign-in (for instance if the password expired), or performs two factor authentication</exception> <remarks> The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than requested could be returned as well. If the access token is expired or close to expiration (within 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call. See https://aka.ms/msal-net-acquiretokensilent for more details </remarks> </member> <member name="P:Microsoft.Identity.Client.IClientApplicationBase.ClientId"> <summary> Gets the Client ID (also known as Application ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app) and as passed in the constructor of the application. </summary> </member> <member name="T:Microsoft.Identity.Client.IConfidentialClientApplication"> <summary> Component to be used with confidential client applications like web apps/API. </summary> <summary> Component to be used with confidential client applications like web apps/APIs. </summary> </member> <member name="P:Microsoft.Identity.Client.IConfidentialClientApplication.AppTokenCache"> <summary> Application token cache. This case holds access tokens for the application. It's maintained and updated silently if needed when calling <see cref="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"/> </summary> <remarks>On .NET Framework and .NET Core you can also customize the token cache serialization. See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on other platforms. </remarks> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenByAuthorizationCode(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> [V3 API] Acquires a security token from the authority configured in the app using the authorization code previously received from the STS. It uses the OAuth 2.0 authorization code flow (See https://aka.ms/msal-net-authorization-code). It's usually used in web apps (for instance ASP.NET / ASP.NET Core web apps) which sign-in users, and can request an authorization code. This method does not lookup the token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/>. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="authorizationCode">The authorization code received from the service authorization endpoint.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can set optional parameters by chaining the builder with, for example <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/>, </remarks> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenForClient(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V3 API] Acquires a token from the authority configured in the app, for the confidential client itself (in the name of no user) using the client credentials flow. See https://aka.ms/msal-net-client-credentials. </summary> <param name="scopes">scopes requested to access a protected API. For this flow (client credentials), the scopes should be of the form "{ResourceIdUri/.default}" for instance <c>https://management.azure.net/.default</c> or, for Microsoft Graph, <c>https://graph.microsoft.com/.default</c> as the requested scopes are really defined statically at application registration in the portal, and cannot be overridden in the application.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder.WithForceRefresh(System.Boolean)"/> <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenOnBehalfOf(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> [V3 API] Acquires an access token for this application (usually a web API) from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. See https://aka.ms/msal-net-on-behalf-of. This confidential client application was itself called with a token which will be provided in the <paramref name="userAssertion">userAssertion</paramref> parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="userAssertion">Instance of <see cref="T:Microsoft.Identity.Client.UserAssertion"/> containing credential information about the user on behalf of whom to get a token.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.GetAuthorizationRequestUrl(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V3 API] Computes the URL of the authorization request letting the user sign-in and consent to the application accessing specific scopes in the user's name. The URL targets the /authorize endpoint of the authority configured in the application. This override enables you to specify a login hint and extra query parameter. </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>A builder enabling you to add optional parameters before executing the token request to get the URL of the STS authorization endpoint parameterized with the parameters</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithRedirectUri(System.String)"/> <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithLoginHint(System.String)"/> <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> In confidential client apps use <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/> instead. </summary> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.GetAccountsAsync"> <summary> Use <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountAsync(System.String)"/> in web apps and web APIs, and use a token cache serializer for better security and performance. See https://aka.ms/msal-net-cca-token-cache-serialization. </summary> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion)"> <summary> [V3 API] Acquires token using On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of) </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="userAssertion">Instance of UserAssertion containing user's token.</param> <returns>Authentication result containing token of the user for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenOnBehalfOfAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UserAssertion,System.String)"> <summary> [V3 API] Acquires token using On-Behalf-Of flow. (See https://aka.ms/msal-net-on-behalf-of) </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="userAssertion">Instance of UserAssertion containing user's token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing token of the user for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenByAuthorizationCodeAsync(System.String,System.Collections.Generic.IEnumerable{System.String})"> <summary> [V2 API] Acquires security token from the authority using authorization code previously received. This method does not lookup token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"/>. </summary> <param name="authorizationCode">The authorization code received from service authorization endpoint.</param> <param name="scopes">Array of scopes requested for resource</param> <returns>Authentication result containing token of the user for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> [V2 API] Acquires token from the service for the confidential client. This method attempts to look up valid access token in the cache. </summary> <param name="scopes">Array of scopes requested for resource</param> <returns>Authentication result containing application token for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.AcquireTokenForClientAsync(System.Collections.Generic.IEnumerable{System.String},System.Boolean)"> <summary> [V2 API] Acquires token from the service for the confidential client. This method attempts to look up valid access token in the cache. </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="forceRefresh">If TRUE, API will ignore the access token in the cache and attempt to acquire new access token using client credentials</param> <returns>Authentication result containing application token for the requested scopes</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.GetAuthorizationRequestUrlAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"> <summary> [V2 API] URL of the authorize endpoint including the query parameters. </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="loginHint">Identifier of the user. Generally a UPN.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The parameter can be null.</param> <returns>URL of the authorize endpoint including the query parameters.</returns> </member> <member name="M:Microsoft.Identity.Client.IConfidentialClientApplication.GetAuthorizationRequestUrlAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.String,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> [V2 API] Gets URL of the authorize endpoint including the query parameters. </summary> <param name="scopes">Array of scopes requested for resource</param> <param name="redirectUri">Address to return to upon receiving a response from the authority.</param> <param name="loginHint">Identifier of the user. Generally a UPN.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The parameter can be null.</param> <param name="extraScopesToConsent">Array of scopes for which a developer can request consent upfront.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>URL of the authorize endpoint including the query parameters.</returns> </member> <member name="T:Microsoft.Identity.Client.ILongRunningWebApi"> <summary> Methods for long running processes in web APIs </summary> </member> <member name="M:Microsoft.Identity.Client.ILongRunningWebApi.InitiateLongRunningProcessInWebApi(System.Collections.Generic.IEnumerable{System.String},System.String,System.String@)"> <summary> Acquires an access token for this web API from the authority configured in the application, in order to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. See https://aka.ms/msal-net-long-running-obo. This confidential client application was itself called with a token which will be provided in the <paramref name="userToken">userToken</paramref> parameter. Use <seealso cref="M:Microsoft.Identity.Client.Extensibility.ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync(Microsoft.Identity.Client.ILongRunningWebApi,System.String,System.Threading.CancellationToken)"/> to stop the long running process. </summary> <remarks> This method should be called once when the long running session is started. </remarks> <param name="scopes">Scopes requested to access a protected API</param> <param name="userToken">A JSON Web Token which was used to call the web API and contains the credential information about the user on behalf of whom to get a token.</param> <param name="longRunningProcessSessionKey">Key by which to look up the token in the cache. If null, it will be set to the assertion hash by default.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> </member> <member name="M:Microsoft.Identity.Client.ILongRunningWebApi.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Retrieves an access token from the cache using the provided cache key that can be used to access another downstream protected web API on behalf of a user using the OAuth 2.0 On-Behalf-Of flow. See https://aka.ms/msal-net-long-running-obo. Use <seealso cref="M:Microsoft.Identity.Client.Extensibility.ConfidentialClientApplicationExtensions.StopLongRunningProcessInWebApiAsync(Microsoft.Identity.Client.ILongRunningWebApi,System.String,System.Threading.CancellationToken)"/> to stop the long running process. </summary> <remarks> This method should be called during the long running session to retrieve the token from the cache </remarks> <param name="scopes">Scopes requested to access a protected API</param> <param name="longRunningProcessSessionKey">Key by which to look up the token in the cache</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <exception cref="T:Microsoft.Identity.Client.MsalClientException"> is thrown if the token cache does not contain a token with an OBO cache key that matches the <paramref name="longRunningProcessSessionKey"/>.</exception> </member> <member name="T:Microsoft.Identity.Client.IManagedIdentityApplication"> <summary> Component to be used with managed identity applications for Azure resources. </summary> </member> <member name="M:Microsoft.Identity.Client.IManagedIdentityApplication.AcquireTokenForManagedIdentity(System.String)"> <summary> Acquires token for a managed identity configured on Azure resource. See https://aka.ms/msal-net-managed-identity. </summary> <param name="resource">resource requested to access the protected API. For this flow (managed identity), the resource should be of the form "{ResourceIdUri}" or {ResourceIdUri/.default} for instance <c>https://management.azure.net</c> or, for Microsoft Graph, <c>https://graph.microsoft.com/.default</c>.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks>You can also chain the following optional parameters: <see cref="M:Microsoft.Identity.Client.AcquireTokenForManagedIdentityParameterBuilder.WithForceRefresh(System.Boolean)"/> </remarks> </member> <member name="M:Microsoft.Identity.Client.Instance.AdfsAuthority.GetTenantedAuthority(System.String,System.Boolean)"> <summary> ADFS seems to support tenanted authorities, but the tenant ID is fixed so for all intents and purposes it remains constant </summary> <param name="tenantId"></param> <param name="forceSpecifiedTenant"></param> <returns></returns> <exception cref="T:System.NotImplementedException"></exception> </member> <member name="T:Microsoft.Identity.Client.Instance.Authority"> <remarks> Must be kept immutable </remarks> </member> <member name="M:Microsoft.Identity.Client.Instance.Authority.CreateAuthorityForRequestAsync(Microsoft.Identity.Client.Internal.RequestContext,Microsoft.Identity.Client.AuthorityInfo,Microsoft.Identity.Client.IAccount)"> <summary> Figures out the authority based on the authority from the config and the authority from the request, and optionally the homeAccountTenantId, which has an impact on AcquireTokenSilent The algorithm is: 1. If there is no request authority (i.e. no authority override), use the config authority. 1.1. For AAD, if the config authority is "common" etc, try to use the tenanted version with the home account tenant ID 2. If there is a request authority, try to use it. 2.1. If the request authority is not "common", then use it 2.2 If the request authority is "common", ignore it, and use 1.1 Special cases: - if the authority is not defined at the application level and the request level is not AAD, use the request authority - if the authority is defined at app level, and the request level authority of is of different type, throw an exception </summary> </member> <member name="M:Microsoft.Identity.Client.Instance.Authority.GetTenantedAuthority(System.String,System.Boolean)"> <summary> Changes the tenant id of the authority, if the authority supports tenants. If not, throws exception,. </summary> <param name="tenantId">The new tenant id</param> <param name="forceSpecifiedTenant">Forces the change, even if the current tenant is not "common" or "organizations" or "consumers"</param> </member> <member name="T:Microsoft.Identity.Client.Instance.AuthorityManager"> <summary> This object is at REQUEST level. </summary> </member> <member name="M:Microsoft.Identity.Client.Instance.CiamAuthority.TransformAuthority(System.Uri)"> <summary> Translates CIAM authorities into a usable form. This is needed only until ESTS is updated to support the north star format North star format: https://idgciamdemo.ciamlogin.com Transformed format: https://idgciamdemo.ciamlogin.com/idgciamdemo.onmicrosoft.com </summary> </member> <member name="T:Microsoft.Identity.Client.Instance.Discovery.IInstanceDiscoveryManager"> <summary> Provides instance metadata across all authority types. Deals with metadata caching. </summary> </member> <member name="T:Microsoft.Identity.Client.Instance.Discovery.InstanceDiscoveryManager"> <summary> Priority order of metadata providers: If user provided metadata via <see cref="M:Microsoft.Identity.Client.AbstractApplicationBuilder`1.WithInstanceDiscoveryMetadata(System.String)"/> use it exclusively. Otherwise: 1. Static cache (this is populated from the network) 2. Well-known cache if all environments present in the token cache are known (this is hard-coded into MSAL) 3. Cache stored in token cache (Not currently implemented) 5. AAD discovery endpoint 6. If going to the network fails with an error different than "invalid_instance" (i.e.authority validation failed), use the well-known instance metadata entry for the given authority 7. On failure, use the authority itself(i.e.preferred cache = preferred network = aliases = configured_authority) Spec: https://identitydivision.visualstudio.com/DevEx/_git/AuthLibrariesApiReview?path=%2FInstance%20Discovery%20Caching%2Fdesktop_web_caching.md </summary> </member> <member name="M:Microsoft.Identity.Client.Instance.Validation.AadAuthorityValidator.ValidateAuthorityAsync(Microsoft.Identity.Client.AuthorityInfo)"> <summary> AAD performs authority validation by calling the instance metadata endpoint. This is a bit unfortunate, because instance metadata is used for aliasing, and authority validation is orthogonal to that. MSAL must figure out aliasing even if ValidateAuthority is set to false. </summary> </member> <member name="M:Microsoft.Identity.Client.Instance.Validation.IAuthorityValidator.ValidateAuthorityAsync(Microsoft.Identity.Client.AuthorityInfo)"> <summary> Validates the authority. This is specific to each authority type. </summary> </member> <member name="M:Microsoft.Identity.Client.Instance.Validation.NullAuthorityValidator.ValidateAuthorityAsync(Microsoft.Identity.Client.AuthorityInfo)"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.Region.IRegionManager.GetAzureRegionAsync(Microsoft.Identity.Client.Internal.RequestContext)"> <summary> Gets the azure region and adds telemetry to the ApiEvents </summary> <returns>Returns null if region should not be used or cannot be discovered.</returns> </member> <member name="T:Microsoft.Identity.Client.Region.RegionAutodetectionSource"> <summary> Indicates where the region information came from. </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionAutodetectionSource.None"> <summary> Indicates that the API .WithAzureRegion() was not used </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionAutodetectionSource.FailedAutoDiscovery"> <summary> Auto-detection failed, fallback to global </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionAutodetectionSource.Cache"> <summary> Auto-detected from MSAL's static cache </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionAutodetectionSource.EnvVariable"> <summary> Auto-detected from Env Variable </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionAutodetectionSource.Imds"> <summary> Auto-detected from IMDS </summary> </member> <member name="T:Microsoft.Identity.Client.Region.RegionOutcome"> <summary> Indicates where the region information came from. </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.None"> <summary> Indicates that the API .WithAzureRegion() was not used </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.UserProvidedValid"> <summary> Region provided by the user, matches auto detected region </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.UserProvidedAutodetectionFailed"> <summary> Region provided by the user, auto detection cannot be done </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.UserProvidedInvalid"> <summary> Region provided by the user, does not match auto detected region </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.AutodetectSuccess"> <summary> Region autodetect requested and was successful </summary> </member> <member name="F:Microsoft.Identity.Client.Region.RegionOutcome.FallbackToGlobal"> <summary> Region autodetect requested but failed. Fallback to global </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Broker.BrokerResponseConst"> <summary> For Android there are from: https://github.com/AzureAD/microsoft-authentication-library-common-for-android/blob/dev/common/src/main/java/com/microsoft/identity/common/internal/broker/BrokerResult.java </summary> </member> <member name="M:Microsoft.Identity.Client.Internal.Broker.IBroker.HandleInstallUrl(System.String)"> <summary> If device auth is required but the broker is not enabled, AAD will signal this by returning an URL pointing to the broker app that needs to be installed. </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Broker.NullBroker"> <summary> For platforms that do not support a broker </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.IdToken.ObjectId"> <summary> The OID claim is a unique identifier (GUID) for the user object in Azure AD. Guest Users have different OID. This is a stable ID across all apps. IMPORTANT: There are rare cases where this is missing! </summary> <remarks> Avoid using as it is not guaranteed non-null. Use <see cref="M:Microsoft.Identity.Client.Internal.IdToken.GetUniqueId"/> instead. </remarks> </member> <member name="P:Microsoft.Identity.Client.Internal.IdToken.Subject"> <summary> The sub claim is a unique identifier for user + app. </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.IServiceBundle.ApplicationLogger"> <summary> When outside of a request, the normal logger (requestContext.Logger) is not available. This logger is at the app level - it is just not tied to a correlation ID. </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.JsonWebToken.JWTHeaderWithCertificate.X509CertificateThumbprint"> <summary> x5t = base64 URL encoded cert thumbprint </summary> <remarks> Mandatory for ADFS 2019 </remarks> </member> <member name="P:Microsoft.Identity.Client.Internal.JsonWebToken.JWTHeaderWithCertificate.X509CertificateKeyId"> <summary> kid (key id) = cert thumbprint </summary> <remarks> Key Id is an optional param, but recommended. Wilson adds both kid and x5t to JWT header </remarks> </member> <member name="F:Microsoft.Identity.Client.Internal.JsonWebTokenConstants.ReservedHeaderParameters.Algorithm"> <summary> Encryption algorithm used, e.g. ES256 https://tools.ietf.org/html/rfc7515#section-4.1.1 </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.JsonWebTokenConstants.ReservedHeaderParameters.Type"> <summary> The type of token e.g. JWT https://tools.ietf.org/html/rfc7519#section-5.1 </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.JsonWebTokenConstants.ReservedHeaderParameters.KeyId"> <summary> Key ID, can be an X509 cert thumbprint. When used with a JWK, the "kid" value is used to match a JWK "kid" parameter value https://tools.ietf.org/html/rfc7515#section-4.1.4 </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.MsalIdParameter.Product"> <summary> MSAL Flavor: .NET or WinRT </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.MsalIdParameter.Version"> <summary> MSAL assembly version </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.MsalIdParameter.CpuPlatform"> <summary> CPU platform with x86, x64 or ARM as value </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.MsalIdParameter.OS"> <summary> Version of the operating system. This will not be sent on WinRT </summary> </member> <member name="F:Microsoft.Identity.Client.Internal.MsalIdParameter.DeviceModel"> <summary> Device model. This will not be sent on .NET </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.MsalIdHelper"> <summary> This class adds additional query parameters or headers to the requests sent to STS. This can help us in collecting statistics and potentially on diagnostics. </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.RequestContext.ApiEvent"> <summary> One and only one ApiEvent is associated with each request. </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters"> <summary> This class is responsible for merging app level and request level parameters. Not all parameters need to be merged - app level parameters can be accessed via AppConfig property </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters.Authority"> <summary> Authority is the URI used by MSAL for communication and storage During a request it can be updated: - with the preferred environment - with actual tenant </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters.Claims"> <summary> Indicates if the user configured claims via .WithClaims. Not affected by Client Capabilities </summary> <remarks>If user configured claims, request should bypass cache</remarks> </member> <member name="P:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters.OnBeforeTokenRequestHandler"> <summary> If set, MSAL should add the key / value pairs from the provider to the token endpoint instead of generating a client assertion </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters.UserAssertion"> <remarks> User assertion is null when <see cref="M:Microsoft.Identity.Client.ILongRunningWebApi.AcquireTokenInLongRunningProcess(System.Collections.Generic.IEnumerable{System.String},System.String)"/> is called. </remarks> </member> <member name="P:Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters.LongRunningOboCacheKey"> <summary> User-provided cache key for long-running OBO flow. </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Requests.IntegratedWindowsAuthRequest"> <summary> Handles requests that are non-interactive. Currently MSAL supports Integrated Windows Auth (IWA). </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Requests.InteractiveRequest"> <summary> This class decides the workflow of an interactive request. The business rules are: 1. If WithBroker is set to true 1.1. Attempt to invoke the broker and get the token 1.2. If this fails, e.g. if broker is not installed, the use a web view (goto 2) 2. Use a webview and get an auth code and look at the auth code 2.1. If the auth code has a special format, showing that a broker is needed then. Invoke the broker flow (step 1) with a broker installation URL 2.2. Otherwise exchange the auth code for tokens (normal authorize_code grant) </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.Requests.RequestBase"> <summary> Base class for all flows. Use by implementing <see cref="M:Microsoft.Identity.Client.Internal.Requests.RequestBase.ExecuteAsync(System.Threading.CancellationToken)"/> and optionally calling protected helper methods such as SendTokenRequestAsync, which know how to use all params when making the request. </summary> </member> <member name="M:Microsoft.Identity.Client.Internal.Requests.RequestBase.GetOverriddenScopes(System.Collections.Generic.ISet{System.String})"> <summary> Return a custom set of scopes to override the default MSAL logic of merging input scopes with reserved scopes (openid, profile etc.) Leave as is / return null otherwise </summary> </member> <member name="M:Microsoft.Identity.Client.Internal.Requests.RequestBase.CreateRegionDetails(Microsoft.Identity.Client.TelemetryCore.Internal.Events.ApiEvent)"> <summary> Creates the region Details </summary> <param name="apiEvent"></param> <returns></returns> </member> <member name="T:Microsoft.Identity.Client.Internal.Requests.UsernamePasswordRequest"> <summary> Handles requests that are non-interactive. Currently MSAL supports Integrated Windows Auth. </summary> </member> <member name="T:Microsoft.Identity.Client.Internal.AuthCodeRequestComponent"> <summary> Responsible for getting an auth code </summary> </member> <member name="M:Microsoft.Identity.Client.Internal.SilentRequestHelper.ProcessFetchInBackground(Microsoft.Identity.Client.Cache.Items.MsalAccessTokenCacheItem,System.Func{System.Threading.Tasks.Task{Microsoft.Identity.Client.AuthenticationResult}},Microsoft.Identity.Client.Core.ILoggerAdapter)"> <summary> Fire and forget the fetch action on a background thread. Do not change to Task and do not await it. </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.ApplicationLogger"> <summary> This logger does not contain a correlation ID and should be used only when the correlation ID is not available i.e. before a request exists </summary> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.HttpManager"> <inheritdoc/> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.WsTrustWebRequestManager"> <inheritdoc/> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.PlatformProxy"> <inheritdoc/> </member> <member name="P:Microsoft.Identity.Client.Internal.ServiceBundle.Config"> <inheritdoc/> </member> <member name="M:Microsoft.Identity.Client.Core.ILoggerAdapter.IsLoggingEnabled(Microsoft.Identity.Client.LogLevel)"> <summary> For expensive logging messages (e.g. when the log message evaluates a variable), it is better to check the log level ahead of time so as not to evaluate the expensive message and then discard it. </summary> </member> <member name="T:Microsoft.Identity.Client.Core.MsalLoggerExtensions"> <summary> Extension methods for ILoggerAdapter </summary> </member> <member name="M:Microsoft.Identity.Client.Core.MsalLoggerExtensions.Info(Microsoft.Identity.Client.Core.ILoggerAdapter,System.Func{System.String})"> <summary> This method is used to avoid string concatenation when the log level is not enabled. </summary> </member> <member name="M:Microsoft.Identity.Client.Core.MsalLoggerExtensions.InfoPii(Microsoft.Identity.Client.Core.ILoggerAdapter,System.Func{System.String},System.Func{System.String})"> <summary> This method is used to avoid string concatenation when the log level is not enabled. </summary> </member> <member name="T:Microsoft.Identity.Client.IntuneAppProtectionPolicyRequiredException"> <summary> This exception is thrown when Intune requires app protection policy. The information in this exception can be used by app to obtain the required enrollment ID from Mobile App Management (MAM) SDK. See https://aka.ms/msal-net-trueMAM </summary> </member> <member name="P:Microsoft.Identity.Client.IntuneAppProtectionPolicyRequiredException.Upn"> <summary> UPN of the user </summary> </member> <member name="P:Microsoft.Identity.Client.IntuneAppProtectionPolicyRequiredException.AccountUserId"> <summary> Local account id </summary> </member> <member name="P:Microsoft.Identity.Client.IntuneAppProtectionPolicyRequiredException.TenantId"> <summary> Tenant ID of the App </summary> </member> <member name="P:Microsoft.Identity.Client.IntuneAppProtectionPolicyRequiredException.AuthorityUrl"> <summary> Authority URL </summary> </member> <member name="M:Microsoft.Identity.Client.IntuneAppProtectionPolicyRequiredException.#ctor(System.String,System.String)"> <summary> Initializes a new instance of the exception class with a specified error code and error message. </summary> <param name="errorCode"> The error code returned by the service or generated by the client. This is the code you can rely on for exception handling. </param> <param name="errorMessage">The error message that explains the reason for the exception.</param> </member> <member name="T:Microsoft.Identity.Client.IPublicClientApplication"> <summary> Component used to acquire tokens in desktop and mobile applications. Public client applications are not trusted to safely keep application secrets and therefore they can only access web APIs in the name of the authenticating user. For more details on differences between public and confidential clients, refer to <see href="https://aka.ms/msal-net-client-applications">our documentation</see>. </summary> <remarks> <para> Unlike <see cref="T:Microsoft.Identity.Client.IConfidentialClientApplication"/>, public clients are unable to securely store secrets on a client device and as a result do not require the use of a client secret. </para> <para> The redirect URI needed for interactive authentication is automatically determined by the library. It does not need to be passed explicitly in the constructor. Depending on the authentication strategy (e.g., through the <see href="https://learn.microsoft.com/entra/msal/dotnet/acquiring-tokens/desktop-mobile/wam?view=msal-dotnet-latest">Web Account Manager</see>, the Authenticator app, web browser, etc.), different redirect URIs will be used by MSAL. Redirect URIs must always be configured for the application in the Azure Portal. </para> </remarks> </member> <member name="P:Microsoft.Identity.Client.IPublicClientApplication.IsSystemWebViewAvailable"> <summary> Tells if the application can use the system web browser, therefore enabling single-sign-on with web applications. By default, MSAL will try to use a system browser on the mobile platforms, if it is available. See <see href="https://aka.ms/msal-net-uses-web-browser">our documentation</see> for more details. </summary> <remarks> On Windows, macOS, and Linux a system browser can always be used, except in cases where there is no UI (e.g., a SSH session). On Android, the browser must support tabs. </remarks> <returns>Returns <c>true</c> if MSAL can use the system web browser.</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenInteractive(System.Collections.Generic.IEnumerable{System.String})"> <summary> Interactive request to acquire a token for the specified scopes. The interactive window will be parented to an application window specified through a handle. The user will be required to select an account. </summary> <param name="scopes">Scopes requested to access a protected API.</param> <returns>A builder enabling you to add optional parameters before executing the token request.</returns> <remarks>The user will be signed-in interactively and will consent to scopes, as well as perform a multi-factor authentication step if such a policy was enabled in the Azure AD tenant. You can also pass optional parameters by calling: <list type="bullet"> <item><description><see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithPrompt(Microsoft.Identity.Client.Prompt)"/> to specify the user experience when signing-in.</description></item> <item><description><see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithUseEmbeddedWebView(System.Boolean)"/> to specify if you want to use the embedded web browser or the default system browser.</description></item> <item><description><see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithSystemWebViewOptions(Microsoft.Identity.Client.SystemWebViewOptions)"/> to configure the user experience when using the default system browser.</description></item> <item><description><see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)"/> or <see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithLoginHint(System.String)"/> to prevent the account selection dialog from appearing if you want to sign-in a specific account.</description></item> <item><description><see cref="M:Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})"/> if you want to let the user pre-consent to additional scopes (which won't be returned in the access token).</description></item> <item><description><see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to pass additional query parameters to the authentication service.</description></item> <item><description>One of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> to override the default authority set at the application construction. Note that the overriding authority needs to be part of the known authorities added to the application constructor.</description></item> </list> </remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCode(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="deviceCodeResultCallback">Callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks> The token acquisition is done in two steps: <list type="bullet"> <item><description>The method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (i.e., to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information.</description></item> </list> See <see href="https://aka.ms/msal-device-code-flow">our documentation</see> for additional context. You can also pass optional parameters by calling <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> and one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> in order to override the default authority. Note that the overriding authority needs to be part of the known authorities added to the application constructor. </remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByIntegratedWindowsAuth(System.Collections.Generic.IEnumerable{System.String})"> <summary> Non-interactive request to acquire a security token for the signed-in user in Windows, via Integrated Windows Authentication. The account used in this overrides is pulled from the operating system as the current user principal name. </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks> See <see href="https://aka.ms/msal-net-iwa">our documentation</see> for more details. You can pass optional parameters by calling <see cref="M:Microsoft.Identity.Client.AcquireTokenByIntegratedWindowsAuthParameterBuilder.WithUsername(System.String)"/> to pass the identifier of the user account for which to acquire a token with Integrated Windows Authentication. This is generally in User Principal Name (UPN) format (e.g. john.doe@contoso.com). This is normally not needed, but some Windows administrators set policies preventing applications from looking up the signed-in user and in that case the username needs to be passed. You can also chain with <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> to pass additional query parameters to the authentication service, along with one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> in order to override the default authority. Note that the overriding authority needs to be part of the known authorities added to the application constructor. </remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"> <summary> Non-interactive request to acquire a token via username and password authentication. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user application requests token on behalf. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="password">User password as a secure string.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks> Available only for .NET Framework and .NET Core applications. See <see href="https://aka.ms/msal-net-up">our documentation</see> for details. You can also pass optional parameters by chaining the builder with <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> and one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> to override the default authority. Note that the overriding authority needs to be part of the known authorities added to the application constructor. .NET no longer recommends using SecureString and MSAL puts the plaintext value of the password on the wire, as required by the OAuth protocol. See <see href="https://docs.microsoft.com/dotnet/api/system.security.securestring?view=net-6.0#remarks">SecureString documentation</see> for details. </remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePassword(System.Collections.Generic.IEnumerable{System.String},System.String,System.String)"> <summary> Non-interactive request to acquire a token via username and password authentication. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user application requests token on behalf. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="password">User password as a string.</param> <returns>A builder enabling you to add optional parameters before executing the token request</returns> <remarks> Available only for .NET Framework and .NET Core applications. See <see href="https://aka.ms/msal-net-up">our documentation</see> for details. You can also pass optional parameters by chaining the builder with <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})"/> and one of the overrides of <see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithAuthority(System.String,System.Boolean)"/> to override the default authority. Note that the overriding authority needs to be part of the known authorities added to the application constructor. </remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> Interactive request to acquire token for the specified scopes. The user is required to select an account </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <remarks>The user will be signed-in interactively if needed, and will consent to scopes and do multi-factor authentication if such a policy was enabled in the Azure AD tenant.</remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the <paramref name="loginHint"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the provided <paramref name="account"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String)"> <summary> Interactive request to acquire token for a login with control of the UI behavior and possibility of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String)"> <summary> Interactive request to acquire token for an account with control of the UI behavior and possibility of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for a given login, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for a given account, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The interactive window will be parented to the specified window. The user will be required to select an account </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <remarks>The user will be signed-in interactively if needed, and will consent to scopes and do multi-factor authentication if such a policy was enabled in the Azure AD tenant.</remarks> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The interactive window will be parented to the specified window. . The user will need to sign-in but an account will be proposed based on the <paramref name="loginHint"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and login</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the provided <paramref name="account"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for a login with control of the UI behavior and possibility of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for an account with control of the UI behavior and possibility of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for a given login, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for a given account, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByUsernamePasswordAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.Security.SecureString)"> <summary> Non-interactive request to acquire a security token from the authority, via Username/Password Authentication. See https://aka.ms/msal-net-up. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user application requests token on behalf. Generally in UserPrincipalName (UPN) format, e.g. john.doe@contoso.com</param> <param name="securePassword">User password.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="deviceCodeResultCallback">Callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task})"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device, with possibility of passing extra parameters. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="deviceCodeResultCallback">Callback containing information to show the user about how to authenticate and enter the device code.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task},System.Threading.CancellationToken)"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device, with possibility of cancelling the token acquisition before it times out. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information. This step is cancelable</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="deviceCodeResultCallback">The callback containing information to show the user about how to authenticate and enter the device code.</param> <param name="cancellationToken">A CancellationToken which can be triggered to cancel the operation in progress.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenWithDeviceCodeAsync(System.Collections.Generic.IEnumerable{System.String},System.String,System.Func{Microsoft.Identity.Client.DeviceCodeResult,System.Threading.Tasks.Task},System.Threading.CancellationToken)"> <summary> Acquires a security token on a device without a web browser, by letting the user authenticate on another device, with possibility of passing extra query parameters and cancelling the token acquisition before it times out. This is done in two steps: <list type="bullet"> <item><description>the method first acquires a device code from the authority and returns it to the caller via the <paramref name="deviceCodeResultCallback"/>. This callback takes care of interacting with the user to direct them to authenticate (to a specific URL, with a code)</description></item> <item><description>The method then proceeds to poll for the security token which is granted upon successful login by the user based on the device code information. This step is cancelable</description></item> </list> See https://aka.ms/msal-device-code-flow. </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="deviceCodeResultCallback">The callback containing information to show the user about how to authenticate and enter the device code.</param> <param name="cancellationToken">A CancellationToken which can be triggered to cancel the operation in progress.</param> <returns>Authentication result containing a token for the requested scopes and for the user who has authenticated on another device with the code</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByIntegratedWindowsAuthAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> Non-interactive request to acquire a security token for the signed-in user in Windows, via Integrated Windows Authentication. See https://aka.ms/msal-net-iwa. The account used in this overrides is pulled from the operating system as the current user principal name </summary> <remarks> On Windows Universal Platform, the following capabilities need to be provided: Enterprise Authentication, Private Networks (Client and Server), User Account Information </remarks> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing a token for the requested scopes and for the currently signed-in user in Windows</returns> </member> <member name="M:Microsoft.Identity.Client.IPublicClientApplication.AcquireTokenByIntegratedWindowsAuthAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Non-interactive request to acquire a security token for the signed-in user in Windows, via Integrated Windows Authentication. See https://aka.ms/msal-net-iwa. The account used in this overrides is pulled from the operating system as the current user principal name </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="username">Identifier of the user account for which to acquire a token with Integrated Windows authentication. Generally in UserPrincipalName (UPN) format, e.g. john.doe@contoso.com</param> <returns>Authentication result containing a token for the requested scopes and for the currently signed-in user in Windows</returns> </member> <member name="T:Microsoft.Identity.Client.TokenCacheCallback"> <summary> Notification for certain token cache interactions during token acquisition. This delegate is used in particular to provide a custom token cache serialization. See https://aka.ms/aka.ms/msal-net-token-cache-serialization </summary> <param name="args">Arguments related to the cache item impacted</param> </member> <member name="T:Microsoft.Identity.Client.ITokenCache"> <summary> This is the interface that implements the public access to cache operations. With CacheV2, this should only be necessary if the caller is persisting the cache in their own store, since this will provide the serialize/deserialize and before/after notifications used in that scenario. See https://aka.ms/aka.ms/msal-net-token-cache-serialization </summary> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetBeforeAccess(Microsoft.Identity.Client.TokenCacheCallback)"> <summary> Sets a delegate to be notified before any library method accesses the cache. This gives an option to the delegate to deserialize a cache entry for the application and accounts specified in the <see cref="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"/>. See https://aka.ms/msal-net-token-cache-serialization. If you need async/task-based callbacks, please use SetBeforeAccessAsync instead. </summary> <param name="beforeAccess">Delegate set in order to handle the cache deserialization</param> <remarks>When the delegate is used to deserialize the cache, it might want to call <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/></remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetAfterAccess(Microsoft.Identity.Client.TokenCacheCallback)"> <summary> Sets a delegate to be notified after any library method accesses the cache. This gives an option to the delegate to serialize a cache entry for the application and accounts specified in the <see cref="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"/>. See https://aka.ms/msal-net-token-cache-serialization. If you need async/task-based callbacks, please use SetAfterAccessAsync instead. </summary> <param name="afterAccess">Delegate set in order to handle the cache serialization in the case where the <see cref="P:Microsoft.Identity.Client.TokenCache.HasStateChanged"/> member of the cache is <c>true</c></param> <remarks>In the case where the delegate is used to serialize the cache entirely (not just a row), it might want to call <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/></remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetBeforeWrite(Microsoft.Identity.Client.TokenCacheCallback)"> <summary> Sets a delegate called before any library method writes to the cache. This gives an option to the delegate to reload the cache state from a row in database and lock that row. That database row can then be unlocked in the delegate registered with <see cref="M:Microsoft.Identity.Client.ITokenCache.SetAfterAccess(Microsoft.Identity.Client.TokenCacheCallback)"/> If you need async/task-based callbacks, please use SetBeforeWriteAsync instead. </summary> <param name="beforeWrite">Delegate set in order to prepare the cache serialization</param> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetBeforeAccessAsync(System.Func{Microsoft.Identity.Client.TokenCacheNotificationArgs,System.Threading.Tasks.Task})"> <summary> Sets a delegate to be notified before any library method accesses the cache. This gives an option to the delegate to deserialize a cache entry for the application and accounts specified in the <see cref="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"/>. See https://aka.ms/msal-net-token-cache-serialization. This provides the same functionality as SetBeforeAccess but it provides for an async/task-based callback. </summary> <param name="beforeAccess">Delegate set in order to handle the cache deserialization</param> <remarks>In the case where the delegate is used to deserialize the cache, it might want to call <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/></remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetAfterAccessAsync(System.Func{Microsoft.Identity.Client.TokenCacheNotificationArgs,System.Threading.Tasks.Task})"> <summary> Sets a delegate to be notified after any library method accesses the cache. This gives an option to the delegate to serialize a cache entry for the application and accounts specified in the <see cref="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"/>. See https://aka.ms/msal-net-token-cache-serialization. This provides the same functionality as SetAfterAccess but it provides for an async/task-based callback. </summary> <param name="afterAccess">Delegate set in order to handle the cache serialization in the case where the <see cref="P:Microsoft.Identity.Client.TokenCache.HasStateChanged"/> member of the cache is <c>true</c></param> <remarks>In the case where the delegate is used to serialize the cache entirely (not just a row), it might want to call <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/></remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SetBeforeWriteAsync(System.Func{Microsoft.Identity.Client.TokenCacheNotificationArgs,System.Threading.Tasks.Task})"> <summary> Sets a delegate called before any library method writes to the cache. This gives an option to the delegate to reload the cache state from a row in database and lock that row. That database row can then be unlocked in the delegate registered with <see cref="M:Microsoft.Identity.Client.ITokenCache.SetAfterAccess(Microsoft.Identity.Client.TokenCacheCallback)"/> This provides the same functionality as SetBeforeWrite but it provides for an async/task-based callback. </summary> <param name="beforeWrite">Delegate set in order to prepare the cache serialization</param> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/> and is accessible in TokenCacheNotificationArgs. </summary> <returns>Byte stream representation of the cache</returns> <remarks> This is the recommended format for maintaining SSO state between applications. <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> and is accessible in TokenCacheNotificationArgs. </summary> <param name="msalV3State">Byte stream representation of the cache</param> <param name="shouldClearExistingCache"> Set to true to clear MSAL cache contents. Defaults to false. You would want to set this to true if you want the cache contents in memory to be exactly what's on disk. You would want to set this to false if you want to merge the contents of what's on disk with your current in memory state. </param> <remarks> This is the recommended format for maintaining SSO state between applications. <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV2"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/> and is accessible in TokenCacheNotificationArgs. </summary> <returns>Byte stream representation of the cache</returns> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV2(System.Byte[])"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/> and is accessible in TokenCacheNotificationArgs. </summary> <param name="msalV2State">Byte stream representation of the cache</param> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SerializeAdalV3"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/> and is accessible in TokenCacheNotificationArgs. </summary> <returns>Byte stream representation of the cache</returns> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.DeserializeAdalV3(System.Byte[])"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> and is accessible in TokenCacheNotificationArgs. See https://aka.ms/msal-net-4x-cache-breaking-change </summary> <param name="adalV3State">Byte stream representation of the cache</param> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCache.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCache.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.Serialize"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/>. See https://aka.ms/msal-net-4x-cache-breaking-change /// </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.Deserialize(System.Byte[])"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/>. See https://aka.ms/msal-net-4x-cache-breaking-change /// </summary> <param name="msalV2State"></param> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.SerializeUnifiedAndAdalCache"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/> and <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/> See https://aka.ms/msal-net-4x-cache-breaking-change </summary> <returns></returns> </member> <member name="M:Microsoft.Identity.Client.ITokenCache.DeserializeUnifiedAndAdalCache(Microsoft.Identity.Client.Cache.CacheData)"> <summary> Functionality replaced by <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/> and <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> See https://aka.ms/msal-net-4x-cache-breaking-change </summary> <param name="cacheData"></param> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheInternal.FindRefreshTokenAsync(Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters,System.String)"> <summary> Returns a RT for the request. If familyId is specified, it tries to return the FRT. </summary> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheInternal.IsFociMemberAsync(Microsoft.Identity.Client.Internal.Requests.AuthenticationRequestParameters,System.String)"> <summary> FOCI - check in the app metadata to see if the app is part of the family </summary> <returns>null if unknown, true or false if app metadata has details</returns> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheInternal.HasTokensNoLocks"> <summary> Shows if MSAL's in-memory token cache has any kind of RT or non-expired AT. Does not trigger a cache notification. Ignores ADAL's cache. </summary> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheInternal.IsAppSubscribedToSerializationEvents"> <summary> True when MSAL has been configured to fire the serialization events. This can be done by the app developer or by MSAL itself (on UWP). </summary> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheInternal.IsExternalSerializationConfiguredByUser"> <summary> True when the app developer subscribed to token cache serialization events. </summary> </member> <member name="T:Microsoft.Identity.Client.ITokenCacheSerializer"> <summary> This interface will be available in TokenCacheNotificationArgs callback to enable serialization/deserialization of the cache. </summary> <remarks> The methods in this class are not thread safe. It is expected that they will be called from the token cache callbacks, registered via SetBeforeAccess, SetAfterAccess. These callbacks thread safe because they are triggered sequentially. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"> <summary> Serializes the token cache to the MSAL.NET 3.x cache format, which is compatible with other MSAL desktop libraries, including MSAL.NET 4.x, MSAL for Python and MSAL for Java. If you need to maintain SSO between an application using ADAL 3.x and this application using MSAL 3.x or later, you might also want to serialize and deserialize with <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/>, otherwise just use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. </summary> <returns>Byte stream representation of the cache</returns> <remarks> This is the recommended format for maintaining SSO state between applications. <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"> <summary> Deserializes the token cache to the MSAL.NET 3.x cache format, which is compatible with other MSAL desktop libraries, including MSAL.NET 4.x, MSAL for Python and MSAL for Java. If you need to maintain SSO between an application using ADAL 3.x and this application using MSAL 3.x or later, you might also want to serialize and deserialize with <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/>, otherwise just use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. </summary> <param name="msalV3State">Byte stream representation of the cache</param> <param name="shouldClearExistingCache"> Set to true to clear MSAL cache contents. Defaults to false. You would want to set this to true if you want the cache contents in memory to be exactly what's on disk. You would want to set this to false if you want to merge the contents of what's on disk with your current in memory state. </param> <remarks> This is the recommended format for maintaining SSO state between applications. <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"> <summary> Serializes a part of the token cache - the refresh tokens - to the ADAL.NET 3.x cache format. If you need to maintain SSO between an application using ADAL 3.x and this application using MSAL 3.x or later, use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> in adition to <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. See https://aka.ms/adal-to-msal-net/cache for details on how to use this advanced API correctly. </summary> <returns>Byte stream representation of the cache</returns> <remarks> Do not use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> without also using <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>, because only refresh tokens are exported in this format. Your applications will not cache access token and id tokens, and will instead need to get them from the identity provider (AAD), which will eventually throttle you. Later versions of ADAL (4.x and 5.x) use the same cache format as MSAL. Only <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. ADAL to MSAL cache interop is only available for public client scenarios and for web site scenario. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"> <summary> Deserializes a part of the token cache - the refresh tokens - to the ADAL.NET 3.x cache format. This API should only be used to maintain SSO between an application using ADAL 3.x and this application using MSAL 3.x or later. Use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> in addition to <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. See https://aka.ms/adal-to-msal-net/cache for details on how to use this advanced API correctly. </summary> <param name="adalV3State">Byte stream representation of the cache</param> <remarks> Do not use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> without also using <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>, because only refresh tokens are exported in this format. Your applications will not cache access token and id tokens, and will instead need to get them from the identity provider (AAD), which will eventually throttle you. Later versions of ADAL (4.x and 5.x) use the same cache format as MSAL. Only <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. ADAL to MSAL cache interop is only available for public client scenarios and for web site scenario. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"> <summary> Serializes the token cache to the MSAL.NET 2.x unified cache format, which is compatible with ADAL.NET v4 and other MSAL.NET v2 applications. If you need to maintain SSO between an application using ADAL 3.x or MSAL 2.x and this application using MSAL 3.x, you might also want to serialize and deserialize with <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> or <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/>, otherwise just use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. </summary> <returns>Byte stream representation of the cache</returns> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"> <summary> Deserializes the token cache to the MSAL.NET 2.x cache format, which is compatible with ADAL.NET v4 and other MSAL.NET v2 applications. If you need to maintain SSO between an application using ADAL 3.x or MSAL 2.x and this application using MSAL 3.x, you might also want to serialize and deserialize with <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeAdalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeAdalV3(System.Byte[])"/> or <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV2"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV2(System.Byte[])"/>, otherwise just use <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/>. </summary> <param name="msalV2State">Byte stream representation of the cache</param> <remarks> <see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.SerializeMsalV3"/>/<see cref="M:Microsoft.Identity.Client.ITokenCacheSerializer.DeserializeMsalV3(System.Byte[],System.Boolean)"/> is compatible with other MSAL libraries such as MSAL for Python and MSAL for Java. </remarks> </member> <member name="T:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes"> <summary> The Kerberos key types used in this assembly. </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes.None"> <summary> None. </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes.DecCbcCrc"> <summary> dec-cbc-crc ([RFC3961] section 6.2.3) </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes.DesCbcMd5"> <summary> des-cbc-md5 ([RFC3961] section 6.2.1) </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes.Aes128CtsHmacSha196"> <summary> aes128-cts-hmac-sha1-96 ([RFC3962] section 6) </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosKeyTypes.Aes256CtsHmacSha196"> <summary> aes256-cts-hmac-sha1-96 ([RFC3962] section 6) </summary> </member> <member name="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket"> <summary> Class for Kerberos tickets that are included as claims and used as a supplemental token in an OAuth/OIDC protocol response. </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ClientKey"> <summary> Get or Sets the client key used to encrypt the client portion of the ticket. This is optional. This will be null if KeyType is null. This MUST be protected in the protocol response. </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.KeyType"> <summary> Get or Sets the client key type.This is optional.This will be null if ClientKey is null. </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.KerberosMessageBuffer"> <summary> Get or Sets the Base64 encoded KERB_MESSAGE_BUFFER </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ErrorMessage"> <summary> Get or Sets the error message that server encountered when creating a ticket granting ticket. </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.Realm"> <summary> Get or Sets the Kerberos realm/domain name. </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ServicePrincipalName"> <summary> Get or Sets the target service principal name (SPN). </summary> </member> <member name="P:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ClientName"> <summary> Get or Sets the client name. Depending on the ticket, this can be either a UserPrincipalName or SamAccountName. </summary> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.#ctor"> <summary> Creates a new instance of <see cref="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket"/> class. </summary> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.#ctor(System.String)"> <summary> Creates a new instance of <see cref="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket"/> class with error message. </summary> <param name="errorMessage">Error message to be set.</param> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket.ToString"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager"> <summary> Helper class to manage Kerberos Ticket Claims. </summary> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.FromIdToken(System.String)"> <summary> Creates a <see cref="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket"/> object from given ID token string.. </summary> <param name="idToken">ID token string.</param> <returns>A <see cref="T:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket"/> object if a Kerberos Ticket Claim exists in the given idToken parameter and is parsed correctly. Null, otherwise.</returns> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.SaveToWindowsTicketCache(Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket)"> <summary> Save current Kerberos Ticket to current user's Ticket Cache. </summary> <param name="ticket">Kerberos ticket object to save.</param> <remarks>Can throws <see cref="T:System.ArgumentException"/> when given ticket parameter is not a valid Kerberos Supplemental Ticket. Can throws <see cref="T:System.ComponentModel.Win32Exception"/> if error occurs while saving ticket information into Ticket Cache. </remarks> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.SaveToWindowsTicketCache(Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket,System.Int64)"> <summary> Save current Kerberos Ticket to current user's Ticket Cache. Windows only. </summary> <param name="ticket">Kerberos ticket object to save.</param> <param name="logonId">The Logon Id of the user owning the ticket cache. The default of 0 represents the currently logged on user.</param> <remarks>Can throw <see cref="T:System.ArgumentException"/> when given ticket parameter is not a valid Kerberos Supplemental Ticket. Can throw <see cref="T:System.ComponentModel.Win32Exception"/> if error occurs while saving ticket information into Ticket Cache. </remarks> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.GetKerberosTicketFromWindowsTicketCache(System.String)"> <summary> Reads a Kerberos Service Ticket associated with given service principal name from current user's Ticket Cache. Windows only. </summary> <param name="servicePrincipalName">Service principal name to find associated Kerberos Ticket.</param> <returns>Byte stream of searched Kerberos Ticket information if exists. Null, otherwise.</returns> <remarks> Can throws <see cref="T:System.ComponentModel.Win32Exception"/> if error occurs while searching ticket information from Ticket Cache. </remarks> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.GetKerberosTicketFromWindowsTicketCache(System.String,System.Int64)"> <summary> Reads a Kerberos Service Ticket associated with given service principal name from current user's Ticket Cache. </summary> <param name="servicePrincipalName">Service principal name to find associated Kerberos Ticket.</param> <param name="logonId">The Logon Id of the user owning the ticket cache. The default of 0 represents the currently logged on user.</param> <returns>Byte stream of searched Kerberos Ticket information if exists. Null, otherwise.</returns> <remarks> Can throws <see cref="T:System.ComponentModel.Win32Exception"/> if error occurs while searching ticket information from Ticket Cache. </remarks> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.GetKrbCred(Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicket)"> <summary> Gets the KRB-CRED Kerberos Ticket information as byte stream. </summary> <param name="ticket">Kerberos ticket object to save.</param> <returns>Byte stream representation of KRB-CRED Kerberos Ticket if it contains valid ticket information. Null, otherwise.</returns> </member> <member name="M:Microsoft.Identity.Client.Kerberos.KerberosSupplementalTicketManager.GetKerberosTicketClaim(System.String,Microsoft.Identity.Client.Kerberos.KerberosTicketContainer)"> <summary> Generate a Kerberos Ticket Claim string. </summary> <param name="servicePrincipalName">Service principal name to use.</param> <param name="ticketContainer">Ticket container to use.</param> <returns>A Kerberos Ticket Claim string if valid service principal name was given. Empty string, otherwise.</returns> </member> <member name="T:Microsoft.Identity.Client.Kerberos.KerberosTicketContainer"> <summary> Declares the type of container to use for Kerberos Ticket Claim. </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosTicketContainer.IdToken"> <summary> Use the Id token as the Kerberos Ticket container. (NOTE) MSAL will read out Kerberos Service Ticket from received id token, cache into current user's ticket cache, and return it as KerberosSupplementalTicket object in AuthenticationResult. </summary> </member> <member name="F:Microsoft.Identity.Client.Kerberos.KerberosTicketContainer.AccessToken"> <summary> Use the Access Token as the Kerberos Ticket container. (NOTE) MSAL will not read out Kerberos Service Ticket from received access token. Caller should handle received access token directly to use for next service request. </summary> </member> <member name="T:Microsoft.Identity.Client.LogCallback"> <summary> Callback delegate that allows application developers to consume logs, and handle them in a custom manner. This callback is set using <see cref="M:Microsoft.Identity.Client.BaseAbstractApplicationBuilder`1.WithLogging(Microsoft.Identity.Client.LogCallback,System.Nullable{Microsoft.Identity.Client.LogLevel},System.Nullable{System.Boolean},System.Nullable{System.Boolean})"/>. If <c>PiiLoggingEnabled</c> is set to <c>true</c>, when registering the callback this method will receive the messages twice: once with the <c>containsPii</c> parameter equals <c>false</c> and the message without PII, and a second time with the <c>containsPii</c> parameter equals to <c>true</c> and the message might contain PII. In some cases (when the message does not contain PII), the message will be the same. For details see https://aka.ms/msal-net-logging </summary> <param name="level">Log level of the log message to process</param> <param name="message">Pre-formatted log message</param> <param name="containsPii">Indicates if the log message contains Organizational Identifiable Information (OII) or Personally Identifiable Information (PII) nor not. If <see cref="P:Microsoft.Identity.Client.Logger.PiiLoggingEnabled"/> is set to <c>false</c> then this value is always false. Otherwise it will be <c>true</c> when the message contains PII.</param> <seealso cref="T:Microsoft.Identity.Client.Logger"/> </member> <member name="T:Microsoft.Identity.Client.LogLevel"> <summary> Represents log level in MSAL. For details, see <see href="https://aka.ms/msal-net-logging">MSAL logging</see>. </summary> </member> <member name="F:Microsoft.Identity.Client.LogLevel.Always"> <summary> Includes logs of important health metrics to help with diagnostics of MSAL operations. </summary> </member> <member name="F:Microsoft.Identity.Client.LogLevel.Error"> <summary> Includes logs when something has gone wrong and an error was generated. Used for debugging and identifying problems. </summary> </member> <member name="F:Microsoft.Identity.Client.LogLevel.Warning"> <summary> Includes logs in scenarios when there hasn't necessarily been an error or failure, but are intended for diagnostics and pinpointing problems. </summary> </member> <member name="F:Microsoft.Identity.Client.LogLevel.Info"> <summary> Default. Includes logs of general events intended for informational purposes, not necessarily intended for debugging. </summary> </member> <member name="F:Microsoft.Identity.Client.LogLevel.Verbose"> <summary> Includes logs of the full details of library behavior. </summary> </member> <member name="T:Microsoft.Identity.Client.ManagedIdentityApplication"> <summary> Class to be used for managed identity applications (on Azure resources like App Services, Virtual Machines, Azure Arc, Service Fabric and Cloud Shell). </summary> <remarks> Managed identity can be enabled on Azure resources as a system assigned managed identity or a user assigned managed identity. </remarks> </member> <member name="M:Microsoft.Identity.Client.ManagedIdentityApplication.AcquireTokenForManagedIdentity(System.String)"> <inheritdoc/> </member> <member name="T:Microsoft.Identity.Client.ManagedIdentity.AbstractManagedIdentity"> <summary> Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/ManagedIdentitySource.cs </summary> </member> <member name="T:Microsoft.Identity.Client.ManagedIdentity.AppServiceManagedIdentitySource"> <summary> Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/AppServiceManagedIdentitySource.cs </summary> </member> <member name="T:Microsoft.Identity.Client.ManagedIdentity.AzureArcManagedIdentitySource"> <summary> Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/AzureArcManagedIdentitySource.cs </summary> </member> <member name="T:Microsoft.Identity.Client.ManagedIdentity.CloudShellManagedIdentitySource"> <summary> Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/CloudShellManagedIdentitySource.cs </summary> </member> <member name="T:Microsoft.Identity.Client.ManagedIdentity.ImdsManagedIdentitySource"> <summary> Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/ImdsManagedIdentitySource.cs </summary> </member> <member name="T:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentityClient"> <summary> Class to initialize a managed identity and identify the service. Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/ManagedIdentityClient.cs </summary> </member> <member name="P:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentityResponse.AccessToken"> <summary> The requested access token. </summary> <remarks>When you call a secured REST API, the token is embedded in the Authorization request header field as a "bearer" token, allowing the API to authenticate the caller.</remarks> </member> <member name="P:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentityResponse.ExpiresOn"> <summary> The timespan when the access token expires. </summary> <remarks>The date is represented as the number of seconds from "1970-01-01T0:0:0Z UTC" (corresponds to the token's exp claim).</remarks> </member> <member name="P:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentityResponse.Resource"> <summary> The resource the access token was requested for. </summary> <remarks>Which matches the resource query string parameter of the request.</remarks> </member> <member name="P:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentityResponse.TokenType"> <summary> The type of token returned by the Managed Identity endpoint. </summary> <remarks>which is a "Bearer" access token, which means the resource can give access to the bearer of this token.</remarks> </member> <member name="P:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentityResponse.ClientId"> <summary> A unique identifier generated by Azure AD for the Azure Resource. </summary> <remarks>The Client ID is a GUID value that uniquely identifies the application and its configuration within the identity platform</remarks> </member> <member name="T:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentitySource"> <summary> Managed identity sources supported. The library will handle these internally. </summary> </member> <member name="F:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentitySource.None"> <summary> Default. </summary> </member> <member name="F:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentitySource.Imds"> <summary> The source to acquire token for managed identity is IMDS. </summary> </member> <member name="F:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentitySource.AppService"> <summary> The source to acquire token for managed identity is App Service. </summary> </member> <member name="F:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentitySource.AzureArc"> <summary> The source to acquire token for managed identity is Azure Arc. </summary> </member> <member name="F:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentitySource.CloudShell"> <summary> The source to acquire token for managed identity is Cloud Shell. </summary> </member> <member name="F:Microsoft.Identity.Client.ManagedIdentity.ManagedIdentitySource.ServiceFabric"> <summary> The source to acquire token for managed identity is Service Fabric. </summary> </member> <member name="T:Microsoft.Identity.Client.ManagedIdentity.ServiceFabricManagedIdentitySource"> <summary> Original source of code: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/src/ServiceFabricManagedIdentitySource.cs </summary> </member> <member name="T:Microsoft.Identity.Client.Metrics"> <summary> MSAL-wide metrics. </summary> </member> <member name="P:Microsoft.Identity.Client.Metrics.TotalAccessTokensFromIdP"> <summary> Total tokens obtained by MSAL from the identity provider. </summary> </member> <member name="P:Microsoft.Identity.Client.Metrics.TotalAccessTokensFromCache"> <summary> Total tokens obtained by MSAL from cache. </summary> </member> <member name="P:Microsoft.Identity.Client.Metrics.TotalAccessTokensFromBroker"> <summary> Total tokens obtained by MSAL from broker. </summary> </member> <member name="P:Microsoft.Identity.Client.Metrics.TotalDurationInMs"> <summary> Total time, in milliseconds, spent in MSAL for all requests. Aggregate of <see cref="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationTotalInMs"/>. </summary> </member> <member name="T:Microsoft.Identity.Client.IUser"> <summary> In MSAL.NET 1.x, was representing a User. From MSAL 2.x use <see cref="T:Microsoft.Identity.Client.IAccount"/> which represents an account (a user has several accounts). See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="P:Microsoft.Identity.Client.IUser.DisplayableId"> <summary> In MSAL.NET 1.x was the displayable ID of a user. From MSAL 2.x use the <see cref="P:Microsoft.Identity.Client.IAccount.Username"/> of an account. See https://aka.ms/msal-net-2-released for more details </summary> </member> <member name="P:Microsoft.Identity.Client.IUser.Name"> <summary> In MSAL.NET 1.x was the name of the user (which was not very useful as the concatenation of some claims). From MSAL 2.x rather use <see cref="P:Microsoft.Identity.Client.IAccount.Username"/>. See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="P:Microsoft.Identity.Client.IUser.IdentityProvider"> <summary> In MSAL.NET 1.x was the URL of the identity provider (e.g. https://login.microsoftonline.com/tenantId). From MSAL.NET 2.x use <see cref="P:Microsoft.Identity.Client.IAccount.Environment"/> which retrieves the host only (e.g. login.microsoftonline.com). See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="P:Microsoft.Identity.Client.IUser.Identifier"> <summary> In MSAL.NET 1.x was an identifier for the user in the guest tenant. From MSAL.NET 2.x, use <see cref="P:Microsoft.Identity.Client.IAccount.HomeAccountId"/><see cref="P:Microsoft.Identity.Client.AccountId.Identifier"/> to get the user identifier (globally unique across tenants). See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="T:Microsoft.Identity.Client.TokenCacheNotificationArgs"> <summary> Contains parameters used by the MSAL call accessing the cache. See also <see cref="T:ITokenCacheSerializer"/> which contains methods to customize the cache serialization. For more details about the token cache see https://aka.ms/msal-net-web-token-cache </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.User"> <summary> In MSAL.NET 1.x, returned the user who signed in to get the authentication result. From MSAL 2.x rather use <see cref="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.Account"/> instead. See https://aka.ms/msal-net-2-released for more details. </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCacheNotificationArgs.#ctor(Microsoft.Identity.Client.ITokenCacheSerializer,System.String,Microsoft.Identity.Client.IAccount,System.Boolean,System.Boolean,System.String,System.Boolean,System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken)"> <summary> This constructor is for test purposes only. It allows apps to unit test their MSAL token cache implementation code. </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCacheNotificationArgs.#ctor(Microsoft.Identity.Client.ITokenCacheSerializer,System.String,Microsoft.Identity.Client.IAccount,System.Boolean,System.Boolean,System.String,System.Boolean,System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken,System.Guid)"> <summary> This constructor is for test purposes only. It allows apps to unit test their MSAL token cache implementation code. </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCacheNotificationArgs.#ctor(Microsoft.Identity.Client.ITokenCacheSerializer,System.String,Microsoft.Identity.Client.IAccount,System.Boolean,System.Boolean,System.String,System.Boolean,System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken,System.Guid,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> This constructor is for test purposes only. It allows apps to unit test their MSAL token cache implementation code. </summary> </member> <member name="M:Microsoft.Identity.Client.TokenCacheNotificationArgs.#ctor(Microsoft.Identity.Client.ITokenCacheSerializer,System.String,Microsoft.Identity.Client.IAccount,System.Boolean,System.Boolean,System.String,System.Boolean,System.Nullable{System.DateTimeOffset},System.Threading.CancellationToken,System.Guid,System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.IdentityModel.Abstractions.IIdentityLogger,System.Boolean,Microsoft.Identity.Client.TelemetryCore.TelemetryClient.TelemetryData)"> <summary> This constructor is for test purposes only. It allows apps to unit test their MSAL token cache implementation code. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.TokenCache"> <summary> Gets the <see cref="T:Microsoft.Identity.Client.ITokenCacheSerializer"/> involved in the transaction </summary> <remarks><see cref="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.TokenCache" > objects</see> implement this interface.</remarks> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.ClientId"> <summary> Gets the ClientId (application ID) of the application involved in the cache transaction </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.Account"> <summary> Gets the account involved in the cache transaction. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.HasStateChanged"> <summary> Indicates whether the state of the cache has changed, for example when tokens are being added or removed. Not all cache operations modify the state of the cache. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.IsApplicationCache"> <summary> Indicates whether the cache change occurred in the UserTokenCache or in the AppTokenCache. </summary> <remarks> The Application Cache is used in Client Credential grant, which is not available on all platforms. See https://aka.ms/msal-net-app-cache-serialization for details. </remarks> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.SuggestedCacheKey"> <summary> A suggested token cache key, which can be used with general purpose storage mechanisms that allow storing key-value pairs and key based retrieval. Useful in applications that store one token cache per user, the recommended pattern for web apps. The value is: <list type="bullet"> <item><description><c>homeAccountId</c> for <c>AcquireTokenSilent</c>, <c>GetAccount(homeAccountId)</c>, <c>RemoveAccount</c> and when writing tokens on confidential client calls</description></item> <item><description><c>"{clientId}__AppTokenCache"</c> for <c>AcquireTokenForClient</c></description></item> <item><description><c>"{clientId}_{tenantId}_AppTokenCache"</c> for <c>AcquireTokenForClient</c> when using a tenant specific authority</description></item> <item><description>the hash of the original token for <c>AcquireTokenOnBehalfOf</c></description></item> </list> </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.HasTokens"> <summary> Is true when at least one non-expired access token exists in the cache. </summary> <remarks> If this flag is false in the OnAfterAccessAsync notification - the node can be deleted from the underlying storage (e.g. IDistributedCache). MSAL takes into consideration access tokens expiration when computing this flag. Use in conjunction with SuggestedCacheExpiry. If a refresh token exists in the cache, this proprety will always be true. </remarks> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.CancellationToken"> <summary> The cancellation token that was passed to AcquireToken* flow via ExecuteAsync(CancellationToken). Can be passed along to the custom token cache implementation. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.CorrelationId"> <summary> The correlation id associated with the request. See <see cref="M:Microsoft.Identity.Client.BaseAbstractAcquireTokenParameterBuilder`1.WithCorrelationId(System.Guid)"/> </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.RequestScopes"> <summary> Scopes specified in the AcquireToken* method. </summary> <remarks> Note that Azure Active Directory may return more scopes than requested, however this property will only contain the scopes requested. </remarks> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.RequestTenantId"> <summary> Tenant Id specified in the AcquireToken* method, if any. </summary> <remarks> Note that if "common" or "organizations" is specified, Azure Active Directory discovers the host tenant for the user, and the tokens are associated with it. This property is not impacted.</remarks> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.SuggestedCacheExpiry"> <summary> Suggested value of the expiry, to help determining the cache eviction time. This value is <b>only</b> set on the <code>OnAfterAccess</code> delegate, on a cache write operation (that is when <code>args.HasStateChanged</code> is <code>true</code>) and when the cache node contains only access tokens. In all other cases it's <code>null</code>. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.IdentityLogger"> <summary> Identity Logger provided at the time of application creation Via WithLogging(IIdentityLogger, bool)/> Calling the log function will automatically add MSAL formatting to the message. For details see https://aka.ms/msal-net-logging </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.PiiLoggingEnabled"> <summary> Boolean used to determine if Personally Identifiable Information (PII) logging is enabled. </summary> </member> <member name="P:Microsoft.Identity.Client.TokenCacheNotificationArgs.TelemetryData"> <summary> Cache Details contains the details of L1/ L2 cache for telemetry logging. </summary> </member> <member name="T:Microsoft.Identity.Client.PublicClientApplication"> <inheritdoc cref="T:Microsoft.Identity.Client.IPublicClientApplication"/> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.#ctor(System.String)"> <summary> Constructor of the application. It will use https://login.microsoftonline.com/common as the default authority. </summary> <param name="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)/. REQUIRED</param> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.#ctor(System.String,System.String)"> <summary> Constructor of the application. </summary> <param name="clientId">Client ID (also named Application ID) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)/. REQUIRED</param> <param name="authority">Authority of the security token service (STS) from which MSAL.NET will acquire the tokens. Usual authorities are: <list type="bullet"> <item><description><c>https://login.microsoftonline.com/tenant/</c>, where <c>tenant</c> is the tenant ID of the Azure AD tenant or a domain associated with this Azure AD tenant, in order to sign-in user of a specific organization only</description></item> <item><description><c>https://login.microsoftonline.com/common/</c> to signing users with any work and school accounts or Microsoft personal account</description></item> <item><description><c>https://login.microsoftonline.com/organizations/</c> to signing users with any work and school accounts</description></item> <item><description><c>https://login.microsoftonline.com/consumers/</c> to signing users with only personal Microsoft account (live)</description></item> </list> Note that this setting needs to be consistent with what is declared in the application registration portal </param> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String})"> <summary> Interactive request to acquire token for the specified scopes. The user is required to select an account </summary> <param name="scopes">Scopes requested to access a protected API</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <remarks>The user will be signed-in interactively if needed, and will consent to scopes and do multi-factor authentication if such a policy was enabled in the Azure AD tenant.</remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the <paramref name="loginHint"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the provided <paramref name="account"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String)"> <summary> Interactive request to acquire token for a login with control of the UI prompt and possibility of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String)"> <summary> Interactive request to acquire token for an account with control of the UI prompt and possibility of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for a given login, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,System.Collections.Generic.IEnumerable{System.String},System.String)"> <summary> Interactive request to acquire token for a given account, with the possibility of controlling the user experience, passing extra query parameters, providing extra scopes that the user can pre-consent to, and overriding the authority pre-configured in the application </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="extraScopesToConsent">Scopes that you can request the end user to consent upfront, in addition to the scopes for the protected web API for which you want to acquire a security token.</param> <param name="authority">Specific authority for which the token is requested. Passing a different value than configured does not change the configured value</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The interactive window will be parented to the specified window. The user will be required to select an account </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> <remarks>The user will be signed-in interactively if needed, and will consent to scopes and do multi-factor authentication if such a policy was enabled in the Azure AD tenant.</remarks> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The interactive window will be parented to the specified window. The user will need to sign-in but an account will be proposed based on the <paramref name="loginHint"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and login</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for the specified scopes. The user will need to sign-in but an account will be proposed based on the provided <paramref name="account"/> </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},System.String,Microsoft.Identity.Client.Prompt,System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for a login with control of the UI prompt and possibility of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="loginHint">Identifier of the user. Generally in UserPrincipalName (UPN) format, e.g. <c>john.doe@contoso.com</c></param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c>key=value</c> separated by an ampersand character. The parameter can be null.</param> <param name="parent">Object containing a reference to the parent window/activity. REQUIRED for Xamarin.Android only.</param> <returns>Authentication result containing a token for the requested scopes and account</returns> </member> <member name="M:Microsoft.Identity.Client.PublicClientApplication.AcquireTokenAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,Microsoft.Identity.Client.Prompt,System.String,Microsoft.Identity.Client.UIParent)"> <summary> Interactive request to acquire token for an account with control of the UI prompt and possibility of passing extra query parameters like additional claims </summary> <param name="scopes">Scopes requested to access a protected API</param> <param name="account">Account to use for the interactive token acquisition. See <see cref="T:Microsoft.Identity.Client.IAccount"/> for ways to get an account</param> <param name="prompt">Designed interactive experience for the user.</param> <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. This is expected to be a string of segments of the form <c&g |