OpenIdClaims (security-parent 3.9.8-SNAPSHOT API)

All Superinterfaces:

Claims, JwtClaims

All Known Implementing Classes:

JWTOpenIdClaims
```
public interface OpenIdClaims
extends JwtClaims
```
ID Token.

Author:

Sergio del Amo

See Also:

ID Token, Standard Claims

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLAIMS_ACR`
`static java.lang.String`	`CLAIMS_ADDRESS`
`static java.lang.String`	`CLAIMS_AMR`
`static java.lang.String`	`CLAIMS_AUTH_TIME`
`static java.lang.String`	`CLAIMS_AZP`
`static java.lang.String`	`CLAIMS_BIRTHDATE`
`static java.lang.String`	`CLAIMS_EMAIL`
`static java.lang.String`	`CLAIMS_EMAIL_VERIFIED`
`static java.lang.String`	`CLAIMS_FAMILY_NAME`
`static java.lang.String`	`CLAIMS_GENDER`
`static java.lang.String`	`CLAIMS_GIVEN_NAME`
`static java.lang.String`	`CLAIMS_LOCALE`
`static java.lang.String`	`CLAIMS_MIDDLE_NAME`
`static java.lang.String`	`CLAIMS_NAME`
`static java.lang.String`	`CLAIMS_NICKNAME`
`static java.lang.String`	`CLAIMS_NONCE`
`static java.lang.String`	`CLAIMS_PHONE_NUMBER`
`static java.lang.String`	`CLAIMS_PHONE_NUMBER_VERIFIED`
`static java.lang.String`	`CLAIMS_PICTURE`
`static java.lang.String`	`CLAIMS_PREFERRED_USERNAME`
`static java.lang.String`	`CLAIMS_PROFILE`
`static java.lang.String`	`CLAIMS_UPDATED_AT`
`static java.lang.String`	`CLAIMS_WEBSITE`
`static java.lang.String`	`CLAIMS_ZONEINFO`

Fields inherited from interface io.micronaut.security.token.jwt.generator.claims.JwtClaims
ALL_CLAIMS, AUDIENCE, EXPIRATION_TIME, ISSUED_AT, ISSUER, JWT_ID, NOT_BEFORE, SUBJECT

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Address`	`getAdress()` address.
`java.util.List<java.lang.String>`	`getAudience()`
`java.lang.String`	`getAuthenticationContextClassReference()`
`java.util.List<java.lang.String>`	`getAuthenticationMethodReferences()`
`java.lang.Integer`	`getAuthenticationTime()`
`java.lang.String`	`getAuthorizedParty()`
`java.lang.String`	`getBirthday()`
`java.util.Map<java.lang.String,java.lang.Object>`	`getClaims()`
`java.lang.String`	`getEmail()`
`java.util.Date`	`getExpirationTime()`
`java.lang.String`	`getFamilyName()` family_name.
`java.lang.String`	`getGender()`
`java.lang.String`	`getGivenName()` given_name.
`java.util.Date`	`getIssuedAt()`
`java.lang.String`	`getIssuer()`
`java.lang.String`	`getLocale()`
`java.lang.String`	`getMiddleName()` middle_name.
`java.lang.String`	`getName()` name.
`java.lang.String`	`getNickname()` nickname.
`java.lang.String`	`getNonce()`
`java.lang.String`	`getPhoneNumber()`
`java.lang.String`	`getPicture()`
`java.lang.String`	`getPreferredUsername()` preferred_username.
`java.lang.String`	`getProfile()`
`java.lang.String`	`getSubject()` sub.
`java.lang.Integer`	`getUpdatedAt()`
`java.lang.String`	`getWebsite()`
`java.lang.String`	`getZoneinfo()` zoneinfo.
`java.lang.Boolean`	`isEmailVerified()`
`java.lang.Boolean`	`isPhoneNumberVerified()`

Methods inherited from interface io.micronaut.security.token.Claims
contains, get, names

- Field Detail
  - CLAIMS_NAME
```
static final java.lang.String CLAIMS_NAME
```
    See Also:
    
    Constant Field Values
  - CLAIMS_GIVEN_NAME
```
static final java.lang.String CLAIMS_GIVEN_NAME
```
    See Also:
    
    Constant Field Values
  - CLAIMS_FAMILY_NAME
```
static final java.lang.String CLAIMS_FAMILY_NAME
```
    See Also:
    
    Constant Field Values
  - CLAIMS_MIDDLE_NAME
```
static final java.lang.String CLAIMS_MIDDLE_NAME
```
    See Also:
    
    Constant Field Values
  - CLAIMS_NICKNAME
```
static final java.lang.String CLAIMS_NICKNAME
```
    See Also:
    
    Constant Field Values
  - CLAIMS_PREFERRED_USERNAME
```
static final java.lang.String CLAIMS_PREFERRED_USERNAME
```
    See Also:
    
    Constant Field Values
  - CLAIMS_PROFILE
```
static final java.lang.String CLAIMS_PROFILE
```
    See Also:
    
    Constant Field Values
  - CLAIMS_PICTURE
```
static final java.lang.String CLAIMS_PICTURE
```
    See Also:
    
    Constant Field Values
  - CLAIMS_WEBSITE
```
static final java.lang.String CLAIMS_WEBSITE
```
    See Also:
    
    Constant Field Values
  - CLAIMS_EMAIL
```
static final java.lang.String CLAIMS_EMAIL
```
    See Also:
    
    Constant Field Values
  - CLAIMS_EMAIL_VERIFIED
```
static final java.lang.String CLAIMS_EMAIL_VERIFIED
```
    See Also:
    
    Constant Field Values
  - CLAIMS_GENDER
```
static final java.lang.String CLAIMS_GENDER
```
    See Also:
    
    Constant Field Values
  - CLAIMS_BIRTHDATE
```
static final java.lang.String CLAIMS_BIRTHDATE
```
    See Also:
    
    Constant Field Values
  - CLAIMS_ZONEINFO
```
static final java.lang.String CLAIMS_ZONEINFO
```
    See Also:
    
    Constant Field Values
  - CLAIMS_LOCALE
```
static final java.lang.String CLAIMS_LOCALE
```
    See Also:
    
    Constant Field Values
  - CLAIMS_PHONE_NUMBER
```
static final java.lang.String CLAIMS_PHONE_NUMBER
```
    See Also:
    
    Constant Field Values
  - CLAIMS_PHONE_NUMBER_VERIFIED
```
static final java.lang.String CLAIMS_PHONE_NUMBER_VERIFIED
```
    See Also:
    
    Constant Field Values
  - CLAIMS_ADDRESS
```
static final java.lang.String CLAIMS_ADDRESS
```
    See Also:
    
    Constant Field Values
  - CLAIMS_UPDATED_AT
```
static final java.lang.String CLAIMS_UPDATED_AT
```
    See Also:
    
    Constant Field Values
  - CLAIMS_AUTH_TIME
```
static final java.lang.String CLAIMS_AUTH_TIME
```
    See Also:
    
    Constant Field Values
  - CLAIMS_NONCE
```
static final java.lang.String CLAIMS_NONCE
```
    See Also:
    
    Constant Field Values
  - CLAIMS_ACR
```
static final java.lang.String CLAIMS_ACR
```
    See Also:
    
    Constant Field Values
  - CLAIMS_AMR
```
static final java.lang.String CLAIMS_AMR
```
    See Also:
    
    Constant Field Values
  - CLAIMS_AZP
```
static final java.lang.String CLAIMS_AZP
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getAuthorizedParty
```
@Nullable
java.lang.String getAuthorizedParty()
```
    Returns:
    
    The party to which the ID Token was issued.
  - getAuthenticationMethodReferences
```
@Nullable
java.util.List<java.lang.String> getAuthenticationMethodReferences()
```
    Returns:
    
    Identifiers for authentication methods used in the authentication.
  - getAuthenticationContextClassReference
```
@Nullable
java.lang.String getAuthenticationContextClassReference()
```
    Returns:
    
    Authentication Context Class Reference.
  - getIssuer
```
@NonNull
java.lang.String getIssuer()
```
    Returns:
    
    Subject Identifier. A locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client,
  - getAudience
```
@NonNull
java.util.List<java.lang.String> getAudience()
```
    Returns:
    
    Audience(s) that this ID Token is intended for.
  - getExpirationTime
```
@NonNull
java.util.Date getExpirationTime()
```
    Returns:
    
    Expiration time on or after which the ID Token MUST NOT be accepted for processing.
  - getIssuedAt
```
@NonNull
java.util.Date getIssuedAt()
```
    Returns:
    
    Time at which the JWT was issued.
  - getSubject
```
@NonNull
java.lang.String getSubject()
```
    sub.
    
    Returns:
    
    Identifier for the End-User at the Issuer.
  - getAuthenticationTime
```
@Nullable
java.lang.Integer getAuthenticationTime()
```
    Returns:
    
    Time when the End-User authentication occurred.
  - getNonce
```
@Nullable
java.lang.String getNonce()
```
    Returns:
    
    String value used to associate a Client session with an ID Token, and to mitigate replay attacks.
  - getName
```
@Nullable
java.lang.String getName()
```
    name.
    
    Returns:
    
    End-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
  - getGivenName
```
@Nullable
java.lang.String getGivenName()
```
    given_name.
    
    Returns:
    
    Given name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
  - getFamilyName
```
@Nullable
java.lang.String getFamilyName()
```
    family_name.
    
    Returns:
    
    Surname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
  - getMiddleName
```
@Nullable
java.lang.String getMiddleName()
```
    middle_name.
    
    Returns:
    
    Middle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
  - getNickname
```
@Nullable
java.lang.String getNickname()
```
    nickname.
    
    Returns:
    
    Casual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
  - getPreferredUsername
```
@Nullable
java.lang.String getPreferredUsername()
```
    preferred_username.
    
    Returns:
    
    Shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
  - getProfile
```
@Nullable
java.lang.String getProfile()
```
    Returns:
    
    URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.
  - getPicture
```
@Nullable
java.lang.String getPicture()
```
    Returns:
    
    URL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.
  - getWebsite
```
@Nullable
java.lang.String getWebsite()
```
    Returns:
    
    URL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.
  - getEmail
```
@Nullable
java.lang.String getEmail()
```
    Returns:
    
    End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
  - isEmailVerified
```
@Nullable
java.lang.Boolean isEmailVerified()
```
    Returns:
    
    True if the End-User's e-mail address has been verified; otherwise false.
  - getGender
```
@Nullable
java.lang.String getGender()
```
    Returns:
    
    End-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.
  - getBirthday
```
@Nullable
java.lang.String getBirthday()
```
    Returns:
    
    End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format.
  - getZoneinfo
```
@Nullable
java.lang.String getZoneinfo()
```
    zoneinfo.
    
    Returns:
    
    String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.
  - getLocale
```
@Nullable
java.lang.String getLocale()
```
    Returns:
    
    End-User's locale, represented as a BCP47 [RFC5646] language tag.
  - getPhoneNumber
```
@Nullable
java.lang.String getPhoneNumber()
```
    Returns:
    
    End-User's preferred telephone number
  - isPhoneNumberVerified
```
@Nullable
java.lang.Boolean isPhoneNumberVerified()
```
    Returns:
    
    True if the End-User's phone number has been verified; otherwise false.
  - getAdress
```
@Nullable
Address getAdress()
```
    address.
    
    Returns:
    
    End-User's preferred postal address.
  - getUpdatedAt
```
@Nullable
java.lang.Integer getUpdatedAt()
```
    Returns:
    
    Time the End-User's information was last updated.
  - getClaims
```
java.util.Map<java.lang.String,java.lang.Object> getClaims()
```
    Returns:
    
    ID token claims

Interface OpenIdClaims

Field Summary

Fields inherited from interface io.micronaut.security.token.jwt.generator.claims.JwtClaims

Method Summary

Methods inherited from interface io.micronaut.security.token.Claims

Field Detail

CLAIMS_NAME

CLAIMS_GIVEN_NAME

CLAIMS_FAMILY_NAME

CLAIMS_MIDDLE_NAME

CLAIMS_NICKNAME

CLAIMS_PREFERRED_USERNAME

CLAIMS_PROFILE

CLAIMS_PICTURE

CLAIMS_WEBSITE

CLAIMS_EMAIL

CLAIMS_EMAIL_VERIFIED

CLAIMS_GENDER

CLAIMS_BIRTHDATE

CLAIMS_ZONEINFO

CLAIMS_LOCALE

CLAIMS_PHONE_NUMBER

CLAIMS_PHONE_NUMBER_VERIFIED

CLAIMS_ADDRESS

CLAIMS_UPDATED_AT

CLAIMS_AUTH_TIME

CLAIMS_NONCE

CLAIMS_ACR

CLAIMS_AMR

CLAIMS_AZP

Method Detail

getAuthorizedParty

getAuthenticationMethodReferences

getAuthenticationContextClassReference

getIssuer

getAudience

getExpirationTime

getIssuedAt

getSubject

getAuthenticationTime

getNonce

getName

getGivenName

getFamilyName

getMiddleName

getNickname

getPreferredUsername

getProfile

getPicture

getWebsite

getEmail

isEmailVerified

getGender

getBirthday

getZoneinfo

getLocale

getPhoneNumber

isPhoneNumberVerified

getAdress

getUpdatedAt

getClaims