Package se.curity.identityserver.sdk.data.events

Class UserInfoOAuthEvent

Object

se.curity.identityserver.sdk.data.events.OAuthEvent

se.curity.identityserver.sdk.data.events.UserInfoOAuthEvent

All Implemented Interfaces:

SerializableAsMap, AuditableEvent, Event

public class UserInfoOAuthEvent
extends OAuthEvent
implements AuditableEvent

Event posted when an oauth-userinfo is successfully queried.

Since:

2.3.0

Constructor Summary

Constructors

Constructor	Description
UserInfoOAuthEvent(String subject, Map<String,Object> claims, @Nullable String accountId, String profileId, String authenticatedSubject)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()	Get a map representation of this Event.
@Nullable String	getAccountId()	Get the ID of the account corresponding to the authenticated subject.
AuditData	getAuditData()	Get all AuditData associated with this auditable event.
@Nullable String	getAuthenticatedSubject()	Get the authenticated subject, i.e., the subject value returned by authentication and stored in the delegation.
Map<String,Object>	getClaims()	Get the unfiltered claims produced by the presented token.
Map<String,Object>	getReturnedClaims()	Deprecated. since 4.1.0
String	getSubject()	Get the subject of the presented token.

Methods inherited from class se.curity.identityserver.sdk.data.events.OAuthEvent

getProfileId, getRequestingClientId, getRequestingClientName, getRequestingSubject, putIfNotNull, toString

Methods inherited from class java.lang.Object

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

Constructor Details

UserInfoOAuthEvent

public UserInfoOAuthEvent(String subject,
 Map<String,Object> claims,
 @Nullable String accountId,
 String profileId,
 String authenticatedSubject)

Method Details

getSubject

public String getSubject()

Get the subject of the presented token.

Returns:

the token subject

getAuthenticatedSubject

@Experimental
@Nullable
public @Nullable String getAuthenticatedSubject()

Get the authenticated subject, i.e., the subject value returned by authentication and stored in the delegation. Note that this value may be different from user info subject when pseudo-anonymization is used.

Returns:

the authenticated subject

Since:

9.0

getClaims

public Map<String,Object> getClaims()

Get the unfiltered claims produced by the presented token.

Returns:

the unfiltered claims

getReturnedClaims

@Deprecated
public Map<String,Object> getReturnedClaims()

Deprecated.

since 4.1.0

Get the claims produced by the presented token and returned to the requester. These claims are filtered by scope.

Returns:

the returned claims

getAccountId

@Nullable
public @Nullable String getAccountId()

Get the ID of the account corresponding to the authenticated subject. Returns null if no account was resolved.

Returns:

the account ID, or null

getAuditData

public AuditData getAuditData()

Description copied from interface: AuditableEvent

Get all AuditData associated with this auditable event.

This method must always return the same instant of AuditData.

Specified by:

getAuditData in interface AuditableEvent

Returns:

the AuditData concisely describing the auditable data of this event

asMap

public Map<String,Object> asMap()

Description copied from interface: Event

Get a map representation of this Event.

Specified by:

asMap in interface Event

Specified by:

asMap in interface SerializableAsMap

Overrides:

asMap in class OAuthEvent

Returns:

a Map representation of this Event. This can be used to serialize events. Sub-types are encouraged to override this method, calling super.asMap() and enriching the returned mutable Map with the more specific information added by the sub-type.