com.microsoft.aad.msal4j

Class ClientCredentialParameters.ClientCredentialParametersBuilder

java.lang.Object

com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder

Enclosing class:

ClientCredentialParameters

public static class ClientCredentialParameters.ClientCredentialParametersBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
ClientCredentialParameters	build()
ClientCredentialParameters.ClientCredentialParametersBuilder	claims(ClaimsRequest claims) Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
ClientCredentialParameters.ClientCredentialParametersBuilder	clientCredential(IClientCredential clientCredential) Overrides the client credentials for this request
ClientCredentialParameters.ClientCredentialParametersBuilder	extraHttpHeaders(Map<String,String> extraHttpHeaders) Adds additional headers to the token request
ClientCredentialParameters.ClientCredentialParametersBuilder	extraQueryParameters(Map<String,String> extraQueryParameters) Deprecated. Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.
ClientCredentialParameters.ClientCredentialParametersBuilder	fmiPath(String fmiPath) Sets the FMI (Federated Managed Identity) path for agent identity scenarios.
ClientCredentialParameters.ClientCredentialParametersBuilder	scopes(Set<String> scopes) Scopes application is requesting access to.
ClientCredentialParameters.ClientCredentialParametersBuilder	skipCache(Boolean skipCache) Indicates whether the request should skip looking into the token cache.
ClientCredentialParameters.ClientCredentialParametersBuilder	tenant(String tenant) Overrides the tenant value in the authority URL for this request
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

scopes

public ClientCredentialParameters.ClientCredentialParametersBuilder scopes(Set<String> scopes)

Scopes application is requesting access to.

Cannot be null.

skipCache

public ClientCredentialParameters.ClientCredentialParametersBuilder skipCache(Boolean skipCache)

Indicates whether the request should skip looking into the token cache. Be default it is set to false.

claims

public ClientCredentialParameters.ClientCredentialParametersBuilder claims(ClaimsRequest claims)

Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims

extraHttpHeaders

public ClientCredentialParameters.ClientCredentialParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Adds additional headers to the token request

extraQueryParameters

@Deprecated
public ClientCredentialParameters.ClientCredentialParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Deprecated. Not recommended for production scenarios. It will be removed in a future release, and the behavior may be replaced by a new API.

Adds additional query parameters to the token request

tenant

public ClientCredentialParameters.ClientCredentialParametersBuilder tenant(String tenant)

Overrides the tenant value in the authority URL for this request

clientCredential

public ClientCredentialParameters.ClientCredentialParametersBuilder clientCredential(IClientCredential clientCredential)

Overrides the client credentials for this request

fmiPath

public ClientCredentialParameters.ClientCredentialParametersBuilder fmiPath(String fmiPath)

Sets the FMI (Federated Managed Identity) path for agent identity scenarios. When set, fmi_path is sent as a body parameter in the client credentials token request, which tells Entra ID to scope the resulting token to a specific agent identity. The token is also cached with an extended cache key to prevent collisions between tokens for different agent identities.

Parameters:

fmiPath - the FMI path value (typically the agent application ID)

Returns:

builder that can be used to construct ClientCredentialParameters

build

public ClientCredentialParameters build()

toString

public String toString()

Overrides:

toString in class Object