Class AcquireTokenByIntegratedWindowsAuthParameterBuilder

Namespace

Microsoft.Identity.Client

Assembly

Microsoft.Identity.Client.dll

Builder for AcquireTokenByIntegratedWindowsAuth

public sealed class AcquireTokenByIntegratedWindowsAuthParameterBuilder : AbstractPublicClientAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>

Inheritance

object

BaseAbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>

AbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>

AbstractPublicClientAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>

AcquireTokenByIntegratedWindowsAuthParameterBuilder

Inherited Members

AbstractPublicClientAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>.ExecuteAsync(CancellationToken)

AbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>.WithClaims(string)

AbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>.WithExtraQueryParameters(string)

AbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>.WithTenantId(string)

AbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>.WithTenantIdFromAuthority(Uri)

AbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>.WithAdfsAuthority(string, bool)

AbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>.WithB2CAuthority(string)

BaseAbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>.ExecuteAsync()

BaseAbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>.WithCorrelationId(Guid)

BaseAbstractAcquireTokenParameterBuilder<AcquireTokenByIntegratedWindowsAuthParameterBuilder>.WithExtraQueryParameters(Dictionary<string, string>)

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

AcquireTokenParameterBuilderExtensions.WithExtraHttpHeaders<T>(AbstractAcquireTokenParameterBuilder<T>, IDictionary<string, string>)

AbstractConfidentialClientAcquireTokenParameterBuilderExtension.OnBeforeTokenRequest<T>(AbstractAcquireTokenParameterBuilder<T>, Func<OnBeforeTokenRequestData, Task>)

AbstractConfidentialClientAcquireTokenParameterBuilderExtension.WithAdditionalCacheParameters<T>(AbstractAcquireTokenParameterBuilder<T>, IEnumerable<string>)

AbstractConfidentialClientAcquireTokenParameterBuilderExtension.WithProofOfPosessionKeyId<T>(AbstractAcquireTokenParameterBuilder<T>, string, string)

Methods

WithFederationMetadata(string)

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.

public AcquireTokenByIntegratedWindowsAuthParameterBuilder WithFederationMetadata(string federationMetadata)

Parameters

federationMetadata string

Federation metadata in the form of XML.

Returns

AcquireTokenByIntegratedWindowsAuthParameterBuilder

The builder to chain the .With methods

WithUsername(string)

Specifies the username.

public AcquireTokenByIntegratedWindowsAuthParameterBuilder WithUsername(string username)

Parameters

username string

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

Returns

AcquireTokenByIntegratedWindowsAuthParameterBuilder

The builder to chain the .With methods.

Remarks

Specifying the username explicitly 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.