|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.nimbusds.openid.connect.sdk.ClaimsRequest com.nimbusds.openid.connect.sdk.IDTokenClaimsRequest
@Immutable public class IDTokenClaimsRequest
Resolved ID Token claims request. Specifies the claims to return with the ID Token. These are determined from the following:
ResponseTypeSet
passed with the
response_type
parameter of the original
OIDCAuthorizationRequest
.
request
or request_uri
parameter of the original
OIDCAuthorizationRequest
.
This class is immutable.
Related specifications:
Field Summary |
---|
Fields inherited from class com.nimbusds.openid.connect.sdk.ClaimsRequest |
---|
requestedClaims, requiredClaims |
Constructor Summary | |
---|---|
IDTokenClaimsRequest(ResponseTypeSet rts,
net.minidev.json.JSONObject idTokenObject,
URL redirectURI,
State state)
Creates a new resolved ID Token claims request. |
Method Summary | |
---|---|
ACRRequest |
getRequestedACRs()
Gets the requested Authentication Context Class References (ACRs) (shorthand method). |
int |
getRequiredMaxAge()
Gets the required maximum authentication age (shorthand method). |
Subject |
getRequiredSubject()
Gets the required subject (shorthand method). |
static Set<String> |
resolveRequiredClaims(ResponseTypeSet rts)
Resolves the required ID Token claims. |
Methods inherited from class com.nimbusds.openid.connect.sdk.ClaimsRequest |
---|
getClaimNames, getRequestedClaimsObject, getRequestedEssentialClaims, getRequestedVoluntaryClaims, getRequiredClaims |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IDTokenClaimsRequest(ResponseTypeSet rts, net.minidev.json.JSONObject idTokenObject, URL redirectURI, State state) throws ResolveException
rts
- The response type set. Obtained from the
response_type
authorisation request
parameter. Must not be null
.idTokenObject
- The id_token
JSON object from the
optional OpenID request object. Obtained from
the decoded request
or
request_uri
authorisation request
parameter. null
if not specified.redirectURI
- The redirection URI, must not be null
.state
- Optional state parameter, null
if not
specified.
ResolveException
- If the ID Token claims request couldn't be
resolved.Method Detail |
---|
public static Set<String> resolveRequiredClaims(ResponseTypeSet rts)
rts
- The response type set. Obtained from the
response_type
authorisation request parameter.
Must not be null
.
public Subject getRequiredSubject() throws ResolveException
Example claim structure:
{ "sub": {"value":"248289761001"}, ... }
null
if not specified.
ResolveException
- If the required subject couldn't be
resolved.public ACRRequest getRequestedACRs() throws ResolveException
Example claim structure:
{ "acr": {"values":["2","http://id.incommon.org/assurance/bronze"]}, ... }
null
if not specified.
ResolveException
- If the required ACRs couldn't be resolved.public int getRequiredMaxAge() throws ResolveException
ResolveException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |