Package io.micronaut.security.oauth2.endpoint.token.response

Interface OpenIdClaims

    • 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