IUserAssertion Interface

public interface IUserAssertion

Interface representing a delegated user identity used by downstream applications in the On-Behalf-Of flow.

The On-Behalf-Of flow is used when a service receives a token from a client application and needs to call another service on behalf of the original user. In this scenario, the received token serves as the user assertion that proves the original user's identity and authentication.

This interface is typically used with OnBehalfOfParameters when acquiring tokens in middle-tier applications that need to call downstream services.

Method Summary

Modifier and Type Method and Description
abstract java.lang.String getAssertion()

Gets the assertion token used in the On-Behalf-Of flow.

abstract java.lang.String getAssertionHash()

Gets a hash of the assertion token.

Method Details

getAssertion

public abstract String getAssertion()

Gets the assertion token used in the On-Behalf-Of flow.

The assertion is typically a JWT token received from an upstream client application that represents the original user's identity and authentication.

Returns:

The assertion token as a string value, usually a JWT.

getAssertionHash

public abstract String getAssertionHash()

Gets a hash of the assertion token.

This hash is used as a key for caching tokens acquired via the On-Behalf-Of flow, allowing the application to efficiently retrieve tokens for the same user assertion without making redundant requests to the token service.

Returns:

Base64 encoded SHA256 hash of the assertion token.

Applies to