Interface ClaimsSourceRequestContext
-
- All Superinterfaces:
InvocationContext
public interface ClaimsSourceRequestContext extends InvocationContext
OpenID Connect claims request context. The supplied context parameters can be used in the processing and accounting of a claims request.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @Nullable net.minidev.json.JSONObject
getClaimsData()
Returns the optional claims fulfillment data.com.nimbusds.openid.connect.sdk.claims.ClaimsTransport
getClaimsTransport()
Returns the claims transport, if applicable.com.nimbusds.oauth2.sdk.id.ClientID
getClientID()
Returns the identifier of the OAuth 2.0 client (client_id).@Nullable String
getClientIPAddress()
Returns the client IP address.@Nullable com.nimbusds.oauth2.sdk.token.AccessToken
getUserInfoAccessToken()
Returns the received and successfully validated UserInfo access token for the claims request.-
Methods inherited from interface com.nimbusds.openid.connect.provider.spi.InvocationContext
getIssuer
-
-
-
-
Method Detail
-
getClaimsTransport
com.nimbusds.openid.connect.sdk.claims.ClaimsTransport getClaimsTransport()
Returns the claims transport, if applicable.- Returns:
UserInfo
orID token
,null
if the claims source SPI is invoked for another purpose (e.g. in aTokenEncoderContext
).
-
getClaimsData
@Nullable net.minidev.json.JSONObject getClaimsData()
Returns the optional claims fulfillment data.- Returns:
- The claims fulfillment data,
null
if not specified.
-
getClientID
com.nimbusds.oauth2.sdk.id.ClientID getClientID()
Returns the identifier of the OAuth 2.0 client (client_id).- Returns:
- The client ID. Not
null
.
-
getClientIPAddress
@Nullable String getClientIPAddress()
Returns the client IP address.- Returns:
- The client IP address,
null
if not available.
-
getUserInfoAccessToken
@Nullable com.nimbusds.oauth2.sdk.token.AccessToken getUserInfoAccessToken()
Returns the received and successfully validated UserInfo access token for the claims request. If a claims request is triggered in a OpenID Connect implicit and hybrid flows, where the claims are returned as part of the ID token, an access token is not involved and hence not returned by this method.The claims source may use the UserInfo access token for the retrieval of aggregated and distributed claims, where the same token is recognised by the upstream claims providers. See OpenID Connect Core 1.0, section 5.6.
- Returns:
- The UserInfo access token,
null
if the claims request wasn't triggered by a UserInfo request.
-
-