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

Class VerifiedClaimsSetRequest

java.lang.Object
com.nimbusds.openid.connect.sdk.claims.ClaimsSetRequest
com.nimbusds.openid.connect.sdk.assurance.request.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"
   },
   "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, section 6.

  • Constructor Details

  • Method Details

    • getVerification

      public VerificationSpec getVerification()
      Gets the verification element.
      Returns:
      The verification element, null if not specified.

    • withVerification

      public VerifiedClaimsSetRequest withVerification(VerificationSpec verification)
      Sets the verification element.
      Parameters:
      verification - The verification element. Must not be null.
      Returns:
      The updated verified claims set request.

    • add

      public VerifiedClaimsSetRequest add(String claimName)
      Description copied from class: ClaimsSetRequest
      Adds the specified claim to the request, using default settings. Shorthand for ClaimsSetRequest.add(Entry).
      Overrides:
      add in class ClaimsSetRequest
      Parameters:
      claimName - The claim name. Must not be null.
      Returns:
      The updated claims set request.

    • add

      public VerifiedClaimsSetRequest add(ClaimsSetRequest.Entry entry)
      Description copied from class: ClaimsSetRequest
      Adds the specified claim to the request.
      Overrides:
      add in class ClaimsSetRequest
      Parameters:
      entry - The individual claim request. Must not be null.
      Returns:
      The updated 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.

    • delete

      public VerifiedClaimsSetRequest delete(String claimName)
      Description copied from class: ClaimsSetRequest
      Deletes the specified claim from this request, in all existing language tag variations if any.
      Overrides:
      delete in class ClaimsSetRequest
      Parameters:
      claimName - The claim name. Must not be null.
      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"
   },
   "claims":{
      "given_name": null,
      "family_name": null,
      "birthdate": null
   }
 }
      Overrides:
      toJSONObject in class ClaimsSetRequest
      Returns:
      The JSON object.

    • 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"
   },
   "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"
   },
   "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.