AcquireTokenForManagedIdentityParameterBuilder Class

Definition

Namespace:
Microsoft.Identity.Client
Assembly:
Microsoft.Identity.Client.dll
Package:
Microsoft.Identity.Client v4.84.2

Builder for AcquireTokenForManagedIdentity (used to get token for managed identities). See https://aka.ms/msal-net-managed-identity

public sealed class AcquireTokenForManagedIdentityParameterBuilder : Microsoft.Identity.Client.AbstractManagedIdentityAcquireTokenParameterBuilder<Microsoft.Identity.Client.AcquireTokenForManagedIdentityParameterBuilder>
type AcquireTokenForManagedIdentityParameterBuilder = class
    inherit AbstractManagedIdentityAcquireTokenParameterBuilder<AcquireTokenForManagedIdentityParameterBuilder>
Public NotInheritable Class AcquireTokenForManagedIdentityParameterBuilder
Inherits AbstractManagedIdentityAcquireTokenParameterBuilder(Of AcquireTokenForManagedIdentityParameterBuilder)
Inheritance
Object
BaseAbstractAcquireTokenParameterBuilder<T>
AbstractManagedIdentityAcquireTokenParameterBuilder<AcquireTokenForManagedIdentityParameterBuilder>
AcquireTokenForManagedIdentityParameterBuilder

Methods

Name Description
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 AbstractManagedIdentityAcquireTokenParameterBuilder<T>)
Validate()

Validates the parameters of the AcquireToken operation.

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

Adds a claims challenge to the token request. The SDK will bypass the token cache when a claims challenge is specified. Retry the token acquisition, and use this value in the WithClaims(String) method. A claims challenge typically arises when calling the protected downstream API, for example when the tenant administrator revokes credentials. Apps are required to look for a 401 Unauthorized response from the protected api and to parse the WWW-Authenticate response header in order to extract the claims. See https://aka.ms/msal-net-claim-challenge for details.
WithClaimsFromClient(String)

Specifies client-originated claims to include in the token request. Unlike WithClaims(String) (for server-issued claims challenges), tokens acquired with client claims are cached and keyed on the claims value. Different claim values produce separate cache entries. Use stable, non-dynamic claim values to avoid cache fragmentation.
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>)
Obsolete.

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

(Inherited from BaseAbstractAcquireTokenParameterBuilder<T>)
WithExtraQueryParameters(IDictionary<String,ValueTuple<String,Boolean>>)

Sets Extra Query Parameters for the query string in the HTTP authentication request with control over which parameters are included in the cache key

(Inherited from BaseAbstractAcquireTokenParameterBuilder<T>)
WithForceRefresh(Boolean)

Specifies if the client application should ignore access tokens when reading the token cache. New tokens will still be written to the application token cache. By default the token is taken from the application token cache (forceRefresh=false)

Extension Methods

Name Description
WithCachePartitionKey<T>(BaseAbstractAcquireTokenParameterBuilder<T>, String, String)

Adds a key-value pair to the token cache key without sending it as a query parameter. Use this to partition cached tokens (e.g., isolating short-lived sessions from regular sessions for the same user). Both AcquireTokenByAuthorizationCode and AcquireTokenSilent must use the same partition key to match cached entries.
WithMtlsProofOfPossession(AcquireTokenForManagedIdentityParameterBuilder)

Enables mTLS Proof-of-Possession for managed identity token acquisition. When attestation is required (KeyGuard scenarios), use the Msal.KeyAttestation package and call .WithAttestationSupport() after this method.

Applies to