Microsoft.Identity.Client.AcquireTokenForClientParameterBuilder

public sealed class AcquireTokenForClientParameterBuilder : AbstractConfidentialClientAcquireTokenParameterBuilder<AcquireTokenForClientParameterBuilder>

Builder for AcquireTokenForClient (used in client credential flows, in daemon applications). See https://aka.ms/msal-net-client-credentials

public AcquireTokenForClientParameterBuilder WithAttributes(string attributeJson)

Specifies an identity attribute to include in the token request. The attribute values will be returned as a claim in the token called "xms_attr" in the access token claims. This is typically used with FMI (Federated Managed Identity) scenarios. Example attribute json: "{\"sg1\":\"0000-00000-0001\",\"sg2\":[\"0000-00000-0002\",\"0000-00000-0003\",\"0000-00000-0004\"]}"

public AcquireTokenForClientParameterBuilder WithAzureRegion(bool useAzureRegion)

Please use WithAzureRegion on the ConfidentialClientApplicationBuilder object

public AcquireTokenForClientParameterBuilder WithFmiPath(string pathSuffix)

Adds an fmi_path parameter to the request. It modifies the subject of the token.

public AcquireTokenForClientParameterBuilder WithForceRefresh(bool forceRefresh)

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)

public AcquireTokenForClientParameterBuilder WithMtlsProofOfPossession()

Specifies that the certificate provided will be used for PoP tokens with mTLS (Mutual TLS) authentication. For more information, refer to the Proof-of-Possession documentation.

public AcquireTokenForClientParameterBuilder WithPreferredAzureRegion(bool useAzureRegion = true, string regionUsedIfAutoDetectFails = "", bool fallbackToGlobal = true)

Please use WithAzureRegion on the ConfidentialClientApplicationBuilder object

public AcquireTokenForClientParameterBuilder WithSendX5C(bool withSendX5C)

Applicable to first-party applications only, this method also allows to specify if the x5c claim should be sent to Azure AD. Sending the x5c enables application developers to achieve easy certificate roll-over in Azure AD: this method will send the certificate chain to Azure AD along with the token request, so that Azure AD can use it to validate the subject name based on a trusted issuer policy. This saves the application admin from the need to explicitly manage the certificate rollover (either via portal or PowerShell/CLI operation). For details see https://aka.ms/msal-net-sni