Microsoft.Identity.Client.Extensibility.AbstractConfidentialClientAcquireTokenParameterBuilderExtension
Extensions for all AcquireToken methods
public static AbstractAcquireTokenParameterBuilder<T> OnBeforeTokenRequest<T>(this AbstractAcquireTokenParameterBuilder<T> builder, Func<OnBeforeTokenRequestData, Task> onBeforeTokenRequestHandler) where T : AbstractAcquireTokenParameterBuilder<T>
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
public static AbstractAcquireTokenParameterBuilder<T> WithAdditionalCacheParameters<T>(this AbstractAcquireTokenParameterBuilder<T> builder, IEnumerable<string> cacheParameters) where T : AbstractAcquireTokenParameterBuilder<T>
Specifies additional parameters acquired from authentication responses to be cached with the access token that are normally not included in the cache object.
these values can be read from the AdditionalResponseParameters parameter.
public static T WithAttributeTokens<T>(this AbstractConfidentialClientAcquireTokenParameterBuilder<T> builder, IEnumerable<string> attributeTokens) where T : AbstractConfidentialClientAcquireTokenParameterBuilder<T>
Sends attributeTokens as the attribute_tokens body parameter
and includes them in the cache key. Null/empty/whitespace entries are ignored;
a null or empty collection is a no-op.
public static AbstractAcquireTokenParameterBuilder<T> WithAuthenticationExtension<T>(this AbstractAcquireTokenParameterBuilder<T> builder, MsalAuthenticationExtension authenticationExtension) where T : AbstractAcquireTokenParameterBuilder<T>
Enables client applications to provide a custom authentication operation to be used in the token acquisition request.
public static T WithClaimsFromClient<T>(this AbstractConfidentialClientAcquireTokenParameterBuilder<T> builder, string claimsJson) where T : AbstractConfidentialClientAcquireTokenParameterBuilder<T>
Specifies client-originated claims to include in the token request.
Unlike WithClaims (for server-issued
claims challenges), tokens acquired with client claims are cached and the cache entry
is keyed on the claims value. Different claims values produce separate cache entries.
Use stable, non-dynamic values to avoid unbounded cache growth.
public static T WithExtraBodyParameters<T>(this AbstractConfidentialClientAcquireTokenParameterBuilder<T> builder, Dictionary<string, Func<CancellationToken, Task<string>>> extraBodyParams) where T : AbstractConfidentialClientAcquireTokenParameterBuilder<T>
Add extra body parameters to the token request. These parameters are added to the cache key
to associate these parameters with the acquired token. Works for confidential client flows
(AcquireTokenForClient, AcquireTokenOnBehalfOf, AcquireTokenByAuthorizationCode).
public static AbstractAcquireTokenParameterBuilder<T> WithExtraClientAssertionClaims<T>(this AbstractAcquireTokenParameterBuilder<T> builder, string clientAssertionClaims) where T : AbstractAcquireTokenParameterBuilder<T>
Specifies extra claims to be included in the client assertion.
These claims will be merged with default claims when the client assertion is generated.
This lets higher level APIs like Microsoft.Identity.Web provide additional claims for the client assertion.
Important: tokens are associated with the extra client assertion claims, which impacts cache lookups.
This is an extensibility API and should not be used by applications directly.
public static AbstractAcquireTokenParameterBuilder<T> WithFmiPathForClientAssertion<T>(this AbstractAcquireTokenParameterBuilder<T> builder, string fmiPath) where T : AbstractAcquireTokenParameterBuilder<T>
Specifies an FMI path to be used for the client assertion. This lets higher level APIs like Id.Web
provide credentials which are FMI sensitive.
Important: tokens are associated with the credential FMI path, which impacts cache lookups
This is an extensibility API and should not be used by applications.
public static AbstractAcquireTokenParameterBuilder<T> WithOtelTagsEnricher<T>(this AbstractAcquireTokenParameterBuilder<T> builder, Action<ExecutionResult, IList<KeyValuePair<string, object>>> tagsEnricher) where T : AbstractAcquireTokenParameterBuilder<T>
Registers a delegate that adds additional tags (dimensions) to the OpenTelemetry metrics MSAL emits
for this token acquisition. The delegate is invoked while MSAL records its metrics and receives the
ExecutionResult of the acquisition (indicating success or failure, with the result or
exception) together with a mutable list of tags. Tags appended to that list are attached to every metric
recorded for the request.
public static AbstractAcquireTokenParameterBuilder<T> WithProofOfPosessionKeyId<T>(this AbstractAcquireTokenParameterBuilder<T> builder, string keyId, string expectedTokenTypeFromAad = "Bearer") where T : AbstractAcquireTokenParameterBuilder<T>
Binds the token to a key in the cache.No cryptographic operations is performed on the token.