AbstractAcquireTokenParameterBuilder<T> Class

Reference

Definition

Namespace:: Microsoft.Identity.Client

Assembly:: Microsoft.Identity.Client.dll

Package:: Microsoft.Identity.Client v4.60.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Base class for builders of token requests, which attempt to acquire a token based on the provided parameters.

public abstract class AbstractAcquireTokenParameterBuilder<T> : Microsoft.Identity.Client.BaseAbstractAcquireTokenParameterBuilder<T> where T : BaseAbstractAcquireTokenParameterBuilder<T>

type AbstractAcquireTokenParameterBuilder<'T (requires 'T :> BaseAbstractAcquireTokenParameterBuilder<'T>)> = class
    inherit BaseAbstractAcquireTokenParameterBuilder<'T (requires 'T :> BaseAbstractAcquireTokenParameterBuilder<'T>)>

Public MustInherit Class AbstractAcquireTokenParameterBuilder(Of T)
Inherits BaseAbstractAcquireTokenParameterBuilder(Of T)

Type Parameters

T

Inheritance: Object

BaseAbstractAcquireTokenParameterBuilder<T>
AbstractAcquireTokenParameterBuilder<T>

Derived: Microsoft.Identity.Client.AbstractClientAppBaseAcquireTokenParameterBuilder<T>

Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<T>

Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder<T>

Constructors

AbstractAcquireTokenParameterBuilder<T>()

Default constructor for AbstractAcquireTokenParameterBuilder.

Methods

ExecuteAsync()	Executes the Token request asynchronously. (Inherited from BaseAbstractAcquireTokenParameterBuilder<T>)
ExecuteAsync(CancellationToken)	Executes the Token request asynchronously, with a possibility of cancelling the asynchronous method. (Inherited from BaseAbstractAcquireTokenParameterBuilder<T>)
Validate()	Validates the parameters of the AcquireToken operation. (Inherited from BaseAbstractAcquireTokenParameterBuilder<T>)
WithAdfsAuthority(String, Boolean)	Adds a known Authority corresponding to an ADFS server. See https://aka.ms/msal-net-adfs.
WithAuthority(AadAuthorityAudience, Boolean)	Obsolete. 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.
WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean)	Obsolete. 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.
WithAuthority(AzureCloudInstance, Guid, Boolean)	Obsolete. 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.
WithAuthority(AzureCloudInstance, String, Boolean)	Obsolete. 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.
WithAuthority(String, Boolean)	Obsolete. 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.
WithAuthority(String, Guid, Boolean)	Obsolete. 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.
WithAuthority(String, String, Boolean)	Obsolete. 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.
WithB2CAuthority(String)	Adds a known authority corresponding to an Azure AD B2C policy. See https://aka.ms/msal-net-b2c-specificities
WithClaims(String)	Sets claims in the query. Use when the AAD admin has enabled conditional access. Acquiring the token normally will result in a MsalUiRequiredException with the Claims property set. Retry the token acquisition, and use this value in the WithClaims(String) method. See https://aka.ms/msal-exceptions for details as well as https://aka.ms/msal-net-claim-challenge.
WithCorrelationId(Guid)	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. (Inherited from BaseAbstractAcquireTokenParameterBuilder<T>)
WithExtraQueryParameters(Dictionary<String,String>)	Sets Extra Query Parameters for the query string in the HTTP authentication request.
WithExtraQueryParameters(String)	Sets Extra Query Parameters for the query string in the HTTP authentication request.
WithScopes(IEnumerable<String>)	Specifies which scopes to request. This method is used when your application needs to specify the scopes needed to call a protected API. See https://docs.microsoft.com/azure/active-directory/develop/v2-permissions-and-consent to learn more about scopes, permissions and consent, and https://docs.microsoft.com/azure/active-directory/develop/msal-v1-app-scopes to learn how to create scopes for legacy applications which used to expose OAuth2 permissions.
WithTenantId(String)	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`.
WithTenantIdFromAuthority(Uri)	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`.

Extension Methods

WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<String,String>)	Adds additional Http Headers to the token request.
OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData,Task>)	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. OnBeforeTokenRequestData

Applies to