Package weblogic.security.provider.authentication.oidc

Interface OIDCAuthenticationContext

public interface OIDCAuthenticationContext

The OIDCAuthenticationContext holds the tokens used in the OIDC authentication process.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SERVLET_REQUEST_ATTRIBUTE_NAME	The HTTP request attribute key used to access the OIDC (OpenID Connect) authentication context.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAccessToken()	Obtain the Access token as a String.
java.lang.String	getIDToken()	Obtain the OIDC ID token as a String in JWT format.
java.lang.String	getIDTokenClaimAsString(java.lang.String claimID)	Obtain the String value for the specified claim ID contained within the ID token.
java.util.Set<java.lang.String>	getIDTokenClaimNames()	Obtain a Set of all valid claim IDs contained within the ID token.
jakarta.json.JsonObject	getIDTokenClaimsAsJson()	Obtain all key/value pairs contained within the ID token claims.

Field Detail

SERVLET_REQUEST_ATTRIBUTE_NAME

static final java.lang.String SERVLET_REQUEST_ATTRIBUTE_NAME

The HTTP request attribute key used to access the OIDC (OpenID Connect) authentication context.

See Also:

Constant Field Values

Method Detail

getIDToken

java.lang.String getIDToken()

Obtain the OIDC ID token as a String in JWT format.

Returns:

A String with the ID token or null if the token is not available.

getAccessToken

java.lang.String getAccessToken()

Obtain the Access token as a String.

Returns:

@return A String with the Access token or null if the token is not available.

getIDTokenClaimNames

java.util.Set<java.lang.String> getIDTokenClaimNames()

Obtain a Set of all valid claim IDs contained within the ID token.

Returns:

A Set with the claim names used by the ID token.

Throws:

java.lang.IllegalArgumentException - if the ID token is absent or cannot be parsed.

getIDTokenClaimAsString

java.lang.String getIDTokenClaimAsString(java.lang.String claimID)

Obtain the String value for the specified claim ID contained within the ID token.

Parameters:

claimID - The claim ID associated with the requested claim.

Returns:

The String value associated with the claim ID.

Throws:

java.lang.IllegalArgumentException - if claim is not found within the ID token.

java.lang.IllegalArgumentException - if the ID token is absent or cannot be parsed.

getIDTokenClaimsAsJson

jakarta.json.JsonObject getIDTokenClaimsAsJson()

Obtain all key/value pairs contained within the ID token claims.

Returns:

A JsonObject with the claim ID value pairs contained within the ID token claims.

Throws:

java.lang.IllegalArgumentException - if the ID token is absent or cannot be parsed.