AcquireTokenInteractiveParameterBuilder Class

Definition

Builder for an Interactive token request. See https://aka.ms/msal-net-acquire-token-interactively

public sealed class AcquireTokenInteractiveParameterBuilder : Microsoft.Identity.Client.AbstractPublicClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenInteractiveParameterBuilder>
type AcquireTokenInteractiveParameterBuilder = class
    inherit AbstractPublicClientAcquireTokenParameterBuilder<AcquireTokenInteractiveParameterBuilder>
Public NotInheritable Class AcquireTokenInteractiveParameterBuilder
Inherits AbstractPublicClientAcquireTokenParameterBuilder(Of AcquireTokenInteractiveParameterBuilder)
Inheritance

Methods

ExecuteAsync()

Executes the Token request asynchronously.

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
ExecuteAsync(CancellationToken) (Inherited from AbstractPublicClientAcquireTokenParameterBuilder<T>)
Validate()

Validates the parameters of the AcquireToken operation.

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithAccount(IAccount)

Sets the account for which the token will be retrieved. This method is mutually exclusive with WithLoginHint(String). If both are used, an exception will be thrown

WithAdfsAuthority(String, Boolean)

Adds a known Authority corresponding to an ADFS server. See https://aka.ms/msal-net-adfs

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(AadAuthorityAudience, Boolean)

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.

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(AzureCloudInstance, AadAuthorityAudience, Boolean)

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.

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(AzureCloudInstance, Guid, Boolean)

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.

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(AzureCloudInstance, String, Boolean)

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.

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(String, Boolean)

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

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(String, Guid, Boolean)

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.

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithAuthority(String, String, Boolean)

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.

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithB2CAuthority(String)

Adds a known authority corresponding to an Azure AD B2C policy. See https://aka.ms/msal-net-b2c-specificities

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithClaims(String)

Sets claims in the query. Use when the AAD admin has enabled conditional access. Acquiring the token normally will result in a MsalServiceException 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

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithCorrelationId(Guid)

Sets the correlation id to be used in the authentication request.

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithExtraQueryParameters(Dictionary<String,String>)

Sets Extra Query Parameters for the query string in the HTTP authentication request

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithExtraQueryParameters(String)

Sets Extra Query Parameters for the query string in the HTTP authentication request

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithExtraScopesToConsent(IEnumerable<String>)
WithLoginHint(String)

Sets the 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 WithAccount(IAccount). If both are used, an exception will be thrown

WithParentActivityOrWindow(IntPtr)

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.

WithParentActivityOrWindow(IWin32Window)

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.

WithParentActivityOrWindow(Object)

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.

WithPrompt(Prompt)

Specifies the what the interactive experience is for the user.

WithScopes(IEnumerable<String>)

Specifies which scopes to request

(Inherited from AbstractAcquireTokenParameterBuilder<T>)
WithSystemWebViewOptions(SystemWebViewOptions)

Specifies options for using the system OS browser handle interactive authentication.

WithUseEmbeddedWebView(Boolean)

Specifies if the public client application should used an embedded web browser or the system default browser

Extension Methods

WithCustomWebUi(AcquireTokenInteractiveParameterBuilder, ICustomWebUi)

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

WithSSHCertificateAuthenticationScheme(AcquireTokenInteractiveParameterBuilder, String, String)

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.

Applies to