Class AbstractClientAppBaseAcquireTokenParameterBuilder<T>

Namespace

Microsoft.Identity.Client

Assembly

Microsoft.Identity.Client.dll

Base class for parameter builders common to public client application and confidential client application token acquisition operations

public abstract class AbstractClientAppBaseAcquireTokenParameterBuilder<T> : AbstractAcquireTokenParameterBuilder<T> where T : AbstractAcquireTokenParameterBuilder<T>

Type Parameters

T

Inheritance

object

BaseAbstractAcquireTokenParameterBuilder<T>

AbstractAcquireTokenParameterBuilder<T>

AbstractClientAppBaseAcquireTokenParameterBuilder<T>

Derived

AcquireTokenByRefreshTokenParameterBuilder

AcquireTokenSilentParameterBuilder

Inherited Members

AbstractAcquireTokenParameterBuilder<T>.WithScopes(IEnumerable<string>)

AbstractAcquireTokenParameterBuilder<T>.WithClaims(string)

AbstractAcquireTokenParameterBuilder<T>.WithExtraQueryParameters(string)

AbstractAcquireTokenParameterBuilder<T>.WithTenantId(string)

AbstractAcquireTokenParameterBuilder<T>.WithTenantIdFromAuthority(Uri)

AbstractAcquireTokenParameterBuilder<T>.WithAdfsAuthority(string, bool)

AbstractAcquireTokenParameterBuilder<T>.WithB2CAuthority(string)

BaseAbstractAcquireTokenParameterBuilder<T>.ExecuteAsync()

BaseAbstractAcquireTokenParameterBuilder<T>.WithCorrelationId(Guid)

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

BaseAbstractAcquireTokenParameterBuilder<T>.Validate()

object.GetType()

object.MemberwiseClone()

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

ExecuteAsync(CancellationToken)

Executes the Token request asynchronously, with a possibility of cancelling the asynchronous method.

public override Task<AuthenticationResult> ExecuteAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Cancellation token. See CancellationToken

Returns

Task<AuthenticationResult>

Authentication result containing a token for the requested scopes and parameters set in the builder.

Remarks

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.

To learn more about potential exceptions thrown by the function, refer to Exceptions in MSAL.NET.