com.pingidentity.pa.sdk.identity

Interface OAuthTokenMetadata

public interface OAuthTokenMetadata

The OAuthTokenMetadata object provides access to additional details about an OAuth token apart from the attributes on Identity.

Method Summary

Modifier and Type	Method and Description
String	getClientId() Returns the client_id of the OAuth client that was issued the token or null if not present.
Instant	getExpiresAt() Returns the calculated value for the expires_in field presented in the OAuth access token response or null if not present.
String	getRealm() Returns the OAuth realm associated with the application.
Instant	getRetrievedAt() Returns the time when PingAccess received the OAuth access token response.
Set<String>	getScopes() Returns the scope of the OAuth access token or empty if not present.
String	getTokenType() Returns the token_type of the OAuth access token.

Method Detail

getClientId

String getClientId()

Returns the client_id of the OAuth client that was issued the token or null if not present.

Returns:

the client_id of the OAuth client that was issued the token

getExpiresAt

Instant getExpiresAt()

Returns the calculated value for the expires_in field presented in the OAuth access token response or null if not present.

Returns:

the calculated value for the expires_in field presented in the OAuth access token response

getRetrievedAt

Instant getRetrievedAt()

Returns the time when PingAccess received the OAuth access token response.

Returns:

the time when PingAccess received the OAuth access token response

getScopes

Set<String> getScopes()

Returns the scope of the OAuth access token or empty if not present.

Returns:

the values for the scope field presented in the OAuth access token response

getTokenType

String getTokenType()

Returns the token_type of the OAuth access token.

Returns:

the token_type of the OAuth access token

getRealm

String getRealm()

Returns the OAuth realm associated with the application. This may be null.

Returns:

the OAuth realm associated with the application