Package sh.ory.hydra.model

Class UserinfoResponse

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-01-12T16:13:57.119092Z[GMT]")
public class UserinfoResponse
extends Object
    The userinfo response

    • Constructor Detail

      • UserinfoResponse

        public UserinfoResponse()

    • Method Detail

      • getBirthdate

        @Nullable
public String getBirthdate()
        End-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.
        Returns:
        birthdate

      • setBirthdate

        public void setBirthdate​(String birthdate)

      • getEmail

        @Nullable
public String getEmail()
        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.
        Returns:
        email

      • setEmail

        public void setEmail​(String email)

      • getEmailVerified

        @Nullable
public Boolean getEmailVerified()
        True if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
        Returns:
        emailVerified

      • setEmailVerified

        public void setEmailVerified​(Boolean emailVerified)

      • getFamilyName

        @Nullable
public String getFamilyName()
        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.
        Returns:
        familyName

      • setFamilyName

        public void setFamilyName​(String familyName)

      • getGender

        @Nullable
public String getGender()
        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.
        Returns:
        gender

      • setGender

        public void setGender​(String gender)

      • getGivenName

        @Nullable
public String getGivenName()
        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.
        Returns:
        givenName

      • setGivenName

        public void setGivenName​(String givenName)

      • getLocale

        @Nullable
public String getLocale()
        End-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.
        Returns:
        locale

      • setLocale

        public void setLocale​(String locale)

      • getMiddleName

        @Nullable
public String getMiddleName()
        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.
        Returns:
        middleName

      • setMiddleName

        public void setMiddleName​(String middleName)

      • getName

        @Nullable
public String getName()
        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.
        Returns:
        name

      • setName

        public void setName​(String name)

      • getNickname

        @Nullable
public String getNickname()
        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.
        Returns:
        nickname

      • setNickname

        public void setNickname​(String nickname)

      • getPhoneNumber

        @Nullable
public String getPhoneNumber()
        End-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.
        Returns:
        phoneNumber

      • setPhoneNumber

        public void setPhoneNumber​(String phoneNumber)

      • getPhoneNumberVerified

        @Nullable
public Boolean getPhoneNumberVerified()
        True if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format.
        Returns:
        phoneNumberVerified

      • setPhoneNumberVerified

        public void setPhoneNumberVerified​(Boolean phoneNumberVerified)

      • getPicture

        @Nullable
public String getPicture()
        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.
        Returns:
        picture

      • setPicture

        public void setPicture​(String picture)

      • getPreferredUsername

        @Nullable
public String getPreferredUsername()
        Non-unique 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.
        Returns:
        preferredUsername

      • setPreferredUsername

        public void setPreferredUsername​(String preferredUsername)

      • getProfile

        @Nullable
public String getProfile()
        URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.
        Returns:
        profile

      • setProfile

        public void setProfile​(String profile)

      • getSub

        @Nullable
public String getSub()
        Subject - Identifier for the End-User at the IssuerURL.
        Returns:
        sub

      • setSub

        public void setSub​(String sub)

      • getUpdatedAt

        @Nullable
public Long getUpdatedAt()
        Time the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
        Returns:
        updatedAt

      • setUpdatedAt

        public void setUpdatedAt​(Long updatedAt)

      • getWebsite

        @Nullable
public String getWebsite()
        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.
        Returns:
        website

      • setWebsite

        public void setWebsite​(String website)

      • getZoneinfo

        @Nullable
public String getZoneinfo()
        String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.
        Returns:
        zoneinfo

      • setZoneinfo

        public void setZoneinfo​(String zoneinfo)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object