com.microsoft.aad.msal4j

Class UserFederatedIdentityCredentialParameters

java.lang.Object

com.microsoft.aad.msal4j.UserFederatedIdentityCredentialParameters

public class UserFederatedIdentityCredentialParameters
extends Object

Object containing parameters for the User Federated Identity Credential (user_fic) flow. This is used for Leg 3 of the agent identity protocol, where a federated identity credential (obtained from Leg 2) is exchanged for a user-scoped token.

Can be used as parameter to ConfidentialClientApplication.acquireToken(UserFederatedIdentityCredentialParameters)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder

Method Summary

Modifier and Type	Method and Description
String	assertion()
static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder	builder(Set<String> scopes, String username, String assertion) Builder for UserFederatedIdentityCredentialParameters using a UPN (User Principal Name).
static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder	builder(Set<String> scopes, UUID userObjectId, String assertion) Builder for UserFederatedIdentityCredentialParameters using a user Object ID.
ClaimsRequest	claims() Gets the claims request parameter that will be sent with the authentication request.
String	clientClaims() Client-originated claims set via UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder.claimsFromClient(String).
String	computeExtCacheKeyHash() Computes the extended cache key hash from all cache key components, or an empty string when there are none.
Map<String,String>	extraHttpHeaders() Gets additional HTTP headers to be included in the token request.
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.
boolean	forceRefresh()
Set<String>	scopes() Gets the set of scopes (permissions) requested for the access token.
String	tenant() Gets the tenant identifier for the token request.
String	username()
UUID	userObjectId()

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes,
                                                                                                                 String username,
                                                                                                                 String assertion)

Builder for UserFederatedIdentityCredentialParameters using a UPN (User Principal Name).

Parameters:

scopes - scopes application is requesting access to

username - the UPN of the target user (e.g., "user@contoso.com")

assertion - the federated identity credential assertion (JWT) obtained from Leg 2

Returns:

builder that can be used to construct UserFederatedIdentityCredentialParameters

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes,
                                                                                                                 UUID userObjectId,
                                                                                                                 String assertion)

Builder for UserFederatedIdentityCredentialParameters using a user Object ID.

Parameters:

scopes - scopes application is requesting access to

userObjectId - the Object ID (OID) of the target user

assertion - the federated identity credential assertion (JWT) obtained from Leg 2

Returns:

builder that can be used to construct UserFederatedIdentityCredentialParameters

scopes

public Set<String> scopes()

Gets the set of scopes (permissions) requested for the access token.

Scopes represent the permissions that the application is requesting access to.

Returns:

A set of scope strings being requested for the access token.

username

public String username()

Returns:

the UPN of the target user, or null if user was identified by Object ID

userObjectId

public UUID userObjectId()

Returns:

the Object ID of the target user, or null if user was identified by UPN

assertion

public String assertion()

Returns:

the federated identity credential assertion (JWT)

forceRefresh

public boolean forceRefresh()

Returns:

whether to bypass the token cache and force a fresh token request

claims

public ClaimsRequest claims()

Gets the claims request parameter that will be sent with the authentication request.

The claims request parameter can be used to request specific claims to be returned in the token, to request MFA authentication, or to control other aspects of token issuance.

Returns:

A ClaimsRequest object containing the requested claims, or null if no claims are specified.

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Gets additional HTTP headers to be included in the token request.

These headers will be added to the HTTP requests sent to the token endpoint. This can be useful for scenarios requiring custom headers for proxies or for diagnostic purposes.

Returns:

A map of additional HTTP headers to include with the token request, or null if no extra headers are needed.

extraQueryParameters

@Deprecated
public 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.

Gets additional query parameters to be included in the token request.

These parameters will be added to the query string in requests to the authorization and token endpoints. This can be useful for scenarios requiring custom parameters that aren't explicitly supported in the library.

Returns:

A map of additional query parameters to include with the token request, or null if no extra parameters are needed.

tenant

public String tenant()

Gets the tenant identifier for the token request.

When specified, this value overrides the tenant specified in the application's authority URL. It can be a tenant ID (GUID), domain name, or one of the special values like "common" or "organizations".

Returns:

The tenant identifier to use for the token request, or null to use the tenant from the authority URL.

clientClaims

public String clientClaims()

Client-originated claims set via UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder.claimsFromClient(String). Forwarded to the token endpoint as the OAuth claims parameter and used as part of the extended cache key so that distinct claim values are cached separately.

Returns:

the client-originated claims JSON, or null if none were provided.

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Computes the extended cache key hash from all cache key components, or an empty string when there are none. The result is memoized since the parameters are immutable after construction.

Returns:

the Base64URL-encoded SHA-256 hash of the cache-key components, or an empty string.