AssertionRequestOptions Class

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

public final class AssertionRequestOptions

Context information passed to assertion provider callbacks when MSAL needs a fresh client assertion. This allows assertion providers to generate context-aware assertions, such as including the FMI path in Federated Managed Identity (agent identity) scenarios.

For more details on agent identity scenarios, see the MSAL documentation on FMI/FIC flows.

Method Summary

Modifier and Type Method and Description
java.lang.String clientAssertionFmiPath()

Gets the FMI (Federated Managed Identity) path for agent identity scenarios.
java.lang.String clientId()

Gets the client ID of the application requesting the assertion.
java.lang.String tokenEndpoint()

Gets the token endpoint URL that the assertion will be sent to.

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

clientAssertionFmiPath

public String clientAssertionFmiPath()

Gets the FMI (Federated Managed Identity) path for agent identity scenarios. When set, this indicates which agent identity the client assertion is being requested for. The assertion provider can use this to include the FMI path in its token acquisition logic.

Returns:

the client assertion FMI path, or null if not applicable

clientId

public String clientId()

Gets the client ID of the application requesting the assertion.

Returns:

the client ID

tokenEndpoint

public String tokenEndpoint()

Gets the token endpoint URL that the assertion will be sent to.

Returns:

the token endpoint URL

Applies to