Package com.c4_soft.springaddons.security.oauth2.test.annotations

Annotation Interface OpenIdClaims

@Target({METHOD,TYPE}) @Retention(RUNTIME) public @interface OpenIdClaims
Configures claims defined at https://datatracker.ietf.org/doc/html/rfc7519#section-4.1 and https://openid.net/specs/openid-connect-core-1_0.html#IDToken
Author:
Jérôme Wacongne <ch4mp@c4-soft.com>

  • Element Details

    • acr

      String acr
      Default:
      ""

    • amr

      String[] amr
      Default:
      {}

    • aud

      String[] aud
      Default:
      {}

    • azp

      String azp
      Default:
      ""

    • authTime

      String authTime
      Returns:
      authentication instant formated as DateTimeFormatter.ISO_INSTANT
      Default:
      ""

    • exp

      String exp
      Returns:
      expiration instant formated as DateTimeFormatter.ISO_INSTANT
      Default:
      ""

    • iat

      String iat
      Returns:
      issue instant formated as DateTimeFormatter.ISO_INSTANT
      Default:
      ""

    • jti

      String jti
      Returns:
      jti (JWT unique identifier)
      Default:
      ""

    • nbf

      String nbf
      Returns:
      nbf (not before) instant formated as DateTimeFormatter.ISO_INSTANT
      Default:
      ""

    • iss

      String iss
      Returns:
      to be parsed as URL
      Default:
      ""

    • nonce

      String nonce
      Default:
      ""

    • sub

      String sub
      Default:
      "user"

    • sessionState

      String sessionState
      Default:
      ""

    • accessTokenHash

      String accessTokenHash
      Default:
      ""

    • authorizationCodeHash

      String authorizationCodeHash
      Default:
      ""

    • address

      OpenIdAddress address
      Default:
      @com.c4_soft.springaddons.security.oauth2.test.annotations.OpenIdAddress

    • birthdate

      String birthdate
      Returns:
      End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DDformat
      Default:
      ""

    • email

      String email
      Default:
      ""

    • emailVerified

      boolean emailVerified
      Default:
      false

    • familyName

      String familyName
      Default:
      ""

    • gender

      String gender
      Default:
      ""

    • givenName

      String givenName
      Default:
      ""

    • locale

      String locale
      Default:
      ""

    • middleName

      String middleName
      Default:
      ""

    • name

      String name
      Default:
      ""

    • nickName

      String nickName
      Default:
      ""

    • phoneNumber

      String phoneNumber
      Default:
      ""

    • phoneNumberVerified

      boolean phoneNumberVerified
      Default:
      false

    • picture

      String picture
      Default:
      ""

    • preferredUsername

      String preferredUsername
      Default:
      ""

    • profile

      String profile
      Default:
      ""

    • updatedAt

      String updatedAt
      Returns:
      issue instant formated as DateTimeFormatter.ISO_INSTANT
      Default:
      ""

    • website

      String website
      Default:
      ""

    • zoneinfo

      String zoneinfo
      Default:
      ""

    • otherClaims

      Claims otherClaims
      Returns:
      intended to define private claims but any claim can be defined there. In case of conflict with an OpenID standard claim, the standard claim wins.
      Default:
      @com.c4_soft.springaddons.security.oauth2.test.annotations.Claims

    • usernameClaim

      String usernameClaim
      Default:
      "sub"

    • jsonFile

      ClasspathClaims jsonFile
      Returns:
      claims from a JSON file on the classpath. In case of conflict this claims have the lowest precedence: jsonFile < json < otherClaims < OpenID standard claims
      Default:
      @com.c4_soft.springaddons.security.oauth2.test.annotations.ClasspathClaims

    • json

      String json
      Returns:
      JSON object string containing all claims. In case of conflict this claims have intermediate precedence: jsonFile < json < otherClaims < OpenID standard claims
      Default:
      ""