UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder Class

Package:
com.microsoft.aad.msal4j
Maven Artifact:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder

public static class UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder

Method Summary

Modifier and Type Method and Description
UserFederatedIdentityCredentialParameters build()
UserFederatedIdentityCredentialParametersBuilder claims(ClaimsRequest claims)

Claims to be requested through the OIDC claims request parameter.
UserFederatedIdentityCredentialParametersBuilder claimsFromClient(String claimsJson)

Specifies client-originated claims (a raw JSON object string) to forward to the token endpoint as the OAuth claims request parameter.
UserFederatedIdentityCredentialParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Adds additional headers to the token request.
UserFederatedIdentityCredentialParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Deprecated

Present only to satisfy the IAcquireTokenParameters interface contract. Not recommended for use — this API is scheduled for removal across all parameter classes and will be replaced by a new mechanism in a future release.
UserFederatedIdentityCredentialParametersBuilder forceRefresh(boolean forceRefresh)

Forces MSAL to refresh the token from the identity provider even if a cached token is available.
UserFederatedIdentityCredentialParametersBuilder tenant(String tenant)

Overrides the tenant value in the authority URL for this request.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

build

public UserFederatedIdentityCredentialParameters build()

claims

public UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder claims(ClaimsRequest claims)

Claims to be requested through the OIDC claims request parameter.

Parameters:

claims

claimsFromClient

public UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder claimsFromClient(String claimsJson)

Specifies client-originated claims (a raw JSON object string) to forward to the token endpoint as the OAuth claims request parameter. Unlike claims(ClaimsRequest claims) (server-issued claims challenges, which bypass the cache), tokens acquired with client claims are cached and the cache entry is keyed on the claims value, so distinct claim values produce separate cache entries. Use stable, non-dynamic values to avoid cache fragmentation. Send the identical value on every request for a given token; because the raw value is part of the cache key, changing or omitting it routes the request to a different cache partition. A blank value is ignored; an invalid JSON object throws MsalClientException.

Parameters:

claimsJson - a valid JSON object string containing the client claims

Returns:

the builder

extraHttpHeaders

public UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Adds additional headers to the token request.

Parameters:

extraHttpHeaders

extraQueryParameters


public UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Deprecated

Present only to satisfy the IAcquireTokenParameters interface contract. Not recommended for use — this API is scheduled for removal across all parameter classes and will be replaced by a new mechanism in a future release.

Parameters:

extraQueryParameters

forceRefresh

public UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder forceRefresh(boolean forceRefresh)

Forces MSAL to refresh the token from the identity provider even if a cached token is available.

Parameters:

forceRefresh - true to bypass the cache; otherwise false. Default is false.

Returns:

the builder

tenant

public UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder tenant(String tenant)

Overrides the tenant value in the authority URL for this request.

Parameters:

tenant

Applies to