Package com.nimbusds.openid.connect.sdk.assurance.claims

Class VerifiedClaimsSetRequest

  • All Implemented Interfaces:
    net.minidev.json.JSONAware
    @Immutable
public class VerifiedClaimsSetRequest
extends ClaimsSetRequest
    OpenID Connect verified claims set request, intended to represent the verified_claims sub-element within a userinfo or id_token element in a claims request parameter.

    Example: 

     {
   "verification": {
      "trust_framework": "eidas_ial_high"
   },
   "claims":{
      "given_name": null,
      "family_name": null,
      "birthdate": null
   }
 }

    Related specifications:

    • OpenID Connect Core 1.0, section 5.5.
    • OpenID Connect for Identity Assurance 1.0.

    • Constructor Detail

      • VerifiedClaimsSetRequest

        public VerifiedClaimsSetRequest()
        Creates a new empty OpenID Connect verified claims set request.

      • VerifiedClaimsSetRequest

        public VerifiedClaimsSetRequest​(Collection<ClaimsSetRequest.Entry> entries,
                                net.minidev.json.JSONObject verificationJSONObject)
        Creates a new OpenID Connect verified claims set request.
        Parameters:
        entries - The request entries. Must not be null.
        verificationJSONObject - The verification JSON object, null if not specified.

    • Method Detail

      • getVerificationJSONObject

        public net.minidev.json.JSONObject getVerificationJSONObject()
        Gets the verification element.
        Returns:
        The verification JSON object, null if not specified.

      • withVerificationJSONObject

        public VerifiedClaimsSetRequest withVerificationJSONObject​(net.minidev.json.JSONObject jsonObject)
        Sets the verification element.
        Parameters:
        jsonObject - The verification JSON object, null if not specified.
        Returns:
        The updated verified claims set request.

      • delete

        public VerifiedClaimsSetRequest delete​(String claimName,
                                       com.nimbusds.langtag.LangTag langTag)
        Description copied from class: ClaimsSetRequest
        Deletes the specified claim from this request.
        Overrides:
        delete in class ClaimsSetRequest
        Parameters:
        claimName - The claim name. Must not be null.
        langTag - The associated language tag, null if none.
        Returns:
        The updated claims set request.

      • toJSONObject

        public net.minidev.json.JSONObject toJSONObject()
        Returns the JSON object representation of this verified claims set request.

        Example: 

         {
   "verification": {
      "trust_framework": "eidas_ial_high"
   },
   "claims":{
      "given_name": null,
      "family_name": null,
      "birthdate": null
   }
 }
        Overrides:
        toJSONObject in class ClaimsSetRequest
        Returns:
        The JSON object, empty if no claims are specified.

      • parse

        public static VerifiedClaimsSetRequest parse​(net.minidev.json.JSONObject jsonObject)
                                      throws ParseException
        Parses an OpenID Connect verified claims set request from the specified JSON object representation.

        Example: 

         {
   "verification": {
      "trust_framework": "eidas_ial_high"
   },
   "claims":{
      "given_name": null,
      "family_name": null,
      "birthdate": null
   }
 }
        Parameters:
        jsonObject - The JSON object to parse. Must not be null.
        Returns:
        The verified claims set request.
        Throws:
        ParseException - If parsing failed.

      • parse

        public static VerifiedClaimsSetRequest parse​(String json)
                                      throws ParseException
        Parses an OpenID Connect verified claims set request from the specified JSON object string representation.

        Example: 

         {
   "verification": {
      "trust_framework": "eidas_ial_high"
   },
   "claims":{
      "given_name": null,
      "family_name": null,
      "birthdate": null
   }
 }
        Parameters:
        json - The JSON object string to parse. Must not be null.
        Returns:
        The verified claims set request.
        Throws:
        ParseException - If parsing failed.