com.nimbusds.openid.connect.sdk
Class UserInfoClaimsRequest

java.lang.Object
  com.nimbusds.openid.connect.sdk.ClaimsRequest
      com.nimbusds.openid.connect.sdk.UserInfoClaimsRequest

@Immutable
public class UserInfoClaimsRequest
extends ClaimsRequest

Resolved UserInfo claims request. Specifies the claims to return at the UserInfo endpoint. These are determined from the following:

• The Scope passed with the scope parameter of the original OIDCAuthorizationRequest.
• The optional OpenID request object passed with the request or request_uri parameter of the original OIDCAuthorizationRequest.

The final UserInfo claims request is determined by listing the default claims for the specified UserInfo Scope and then merging the UserInfo claims from the optional OpenID request object.

This class is immutable.

Related specifications:

• OpenID Connect Messages 1.0, section 2.1.1.1.1.

Version:

$version$ (2013-01-21)

Author:

Vladimir Dzhuvinov

Field Summary

Fields inherited from class com.nimbusds.openid.connect.sdk.ClaimsRequest

requestedClaims, requiredClaims

Constructor Summary

UserInfoClaimsRequest(Scope scope, net.minidev.json.JSONObject userInfoObject)
Creates a new resolved UserInfo claims request.

Method Summary

static net.minidev.json.JSONObject	getClaimsObjectForScope(Scope scope) Gets the default claims request JSON object for the specified UserInfo scope.
com.nimbusds.langtag.LangTag[]	getPreferredLocales() Gets the preferred locales.

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

UserInfoClaimsRequest

public UserInfoClaimsRequest(Scope scope,
                             net.minidev.json.JSONObject userInfoObject)
                      throws ResolveException

Creates a new resolved UserInfo claims request.

Parameters:

scope - The UserInfo scope. Corresponds to the scope authorisation request parameter. Must not be null.

userInfoObject - The userinfo JSON object from the optional OpenID request object. Obtained from the decoded request or request_uri authorisation request parameter. null if not specified.

Throws:

ResolveException - If the ID Token claims request couldn't be resolved.

Method Detail

getClaimsObjectForScope

public static net.minidev.json.JSONObject getClaimsObjectForScope(Scope scope)

Gets the default claims request JSON object for the specified UserInfo scope.

Parameters:

scope - The UserInfo scope. Must include an openid scope token and must not be null.

Returns:

The matching UserInfo claims request JSON object.

getPreferredLocales

public com.nimbusds.langtag.LangTag[] getPreferredLocales()

Gets the preferred locales.

Returns:

The preferred locales, by order of preference, null if none.