com.pingidentity.pa.sdk.identity

Interface Identity

public interface Identity

An Identity object contains attributes and associated values derived from an authentication token issued by a token provider. The actual token can be a PA JWT cookie or an OAuth token.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	getAttributes() Returns the JSON representation of the identity attributes.
String	getMappedSubject() Returns the subject as set by a IdentityMappingPlugin.
OAuthTokenMetadata	getOAuthTokenMetadata() Returns additional data about an OAuth token when the authentication source is OAuth.
SessionStateSupport	getSessionStateSupport() Returns the session state for the exchange.
String	getSubject() Returns the subject for the authenticated identity.
Instant	getTokenExpiration() Returns the expiration time presented from the authentication source.
String	getTokenId() Returns the unique ID presented in the authentication token.
String	getTrackingId() Returns the tracking identifier used in the PingAccess logs for this identity.
void	setMappedSubject(String subject) Called by a IdentityMappingPlugin to set the subject.

Method Detail

getSubject

String getSubject()

Returns the subject for the authenticated identity.

Returns:

The subject of the authenticated identity

getAttributes

com.fasterxml.jackson.databind.JsonNode getAttributes()

Returns the JSON representation of the identity attributes. Modifications to the returned JsonNode will not update the identity's attributes.

Returns:

The JSON representation of the identity as returned from the authentication source

getMappedSubject

String getMappedSubject()

Returns the subject as set by a IdentityMappingPlugin. The returned value may be null if identity mapping was not configured for the request. The value may be an empty string if the configured IdentityMappingPlugin was unable to find a mapped subject for the identity.

Returns:

the mapped subject set by an IdentityMapping

setMappedSubject

void setMappedSubject(String subject)

Called by a IdentityMappingPlugin to set the subject.

Parameters:

subject - the subject as mapped by an IdentityMapping

getOAuthTokenMetadata

OAuthTokenMetadata getOAuthTokenMetadata()

Returns additional data about an OAuth token when the authentication source is OAuth. This will return null if OAuth is not used.

Returns:

additional OAuth details or null if OAuth is not used for authentication

getTrackingId

String getTrackingId()

Returns the tracking identifier used in the PingAccess logs for this identity. This ID is not guaranteed to be globally unique and should be used for logging purposes only.

Returns:

the tracking identifier used in the PingAccess logs for this identity.

getTokenId

String getTokenId()

Returns the unique ID presented in the authentication token. This value may change for the identity if the token is regenerated.

Returns:

the ID presented in the authentication token

getTokenExpiration

Instant getTokenExpiration()

Returns the expiration time presented from the authentication source. This may be null if the authentication source did not provide an expiration.

Returns:

the authentication expiration time

getSessionStateSupport

SessionStateSupport getSessionStateSupport()

Returns the session state for the exchange.

Returns:

the session state for the exchange