Back to Hydra

OidcUserInfo

internal/httpclient/docs/OidcUserInfo.md

26.2.017.7 KB
Original Source

OidcUserInfo

Properties

NameTypeDescriptionNotes
BirthdatePointer to stringEnd-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.[optional]
EmailPointer to stringEnd-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.[optional]
EmailVerifiedPointer to boolTrue 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.[optional]
FamilyNamePointer to stringSurname(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.[optional]
GenderPointer to stringEnd-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.[optional]
GivenNamePointer to stringGiven 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.[optional]
LocalePointer to stringEnd-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.[optional]
MiddleNamePointer to stringMiddle 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.[optional]
NamePointer to stringEnd-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.[optional]
NicknamePointer to stringCasual 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.[optional]
PhoneNumberPointer to stringEnd-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.[optional]
PhoneNumberVerifiedPointer to boolTrue 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.[optional]
PicturePointer to stringURL 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.[optional]
PreferredUsernamePointer to stringNon-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.[optional]
ProfilePointer to stringURL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.[optional]
SubPointer to stringSubject - Identifier for the End-User at the IssuerURL.[optional]
UpdatedAtPointer to int64Time 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.[optional]
WebsitePointer to stringURL 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.[optional]
ZoneinfoPointer to stringString from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.[optional]

Methods

NewOidcUserInfo

func NewOidcUserInfo() *OidcUserInfo

NewOidcUserInfo instantiates a new OidcUserInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewOidcUserInfoWithDefaults

func NewOidcUserInfoWithDefaults() *OidcUserInfo

NewOidcUserInfoWithDefaults instantiates a new OidcUserInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetBirthdate

func (o *OidcUserInfo) GetBirthdate() string

GetBirthdate returns the Birthdate field if non-nil, zero value otherwise.

GetBirthdateOk

func (o *OidcUserInfo) GetBirthdateOk() (*string, bool)

GetBirthdateOk returns a tuple with the Birthdate field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetBirthdate

func (o *OidcUserInfo) SetBirthdate(v string)

SetBirthdate sets Birthdate field to given value.

HasBirthdate

func (o *OidcUserInfo) HasBirthdate() bool

HasBirthdate returns a boolean if a field has been set.

GetEmail

func (o *OidcUserInfo) GetEmail() string

GetEmail returns the Email field if non-nil, zero value otherwise.

GetEmailOk

func (o *OidcUserInfo) GetEmailOk() (*string, bool)

GetEmailOk returns a tuple with the Email field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEmail

func (o *OidcUserInfo) SetEmail(v string)

SetEmail sets Email field to given value.

HasEmail

func (o *OidcUserInfo) HasEmail() bool

HasEmail returns a boolean if a field has been set.

GetEmailVerified

func (o *OidcUserInfo) GetEmailVerified() bool

GetEmailVerified returns the EmailVerified field if non-nil, zero value otherwise.

GetEmailVerifiedOk

func (o *OidcUserInfo) GetEmailVerifiedOk() (*bool, bool)

GetEmailVerifiedOk returns a tuple with the EmailVerified field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEmailVerified

func (o *OidcUserInfo) SetEmailVerified(v bool)

SetEmailVerified sets EmailVerified field to given value.

HasEmailVerified

func (o *OidcUserInfo) HasEmailVerified() bool

HasEmailVerified returns a boolean if a field has been set.

GetFamilyName

func (o *OidcUserInfo) GetFamilyName() string

GetFamilyName returns the FamilyName field if non-nil, zero value otherwise.

GetFamilyNameOk

func (o *OidcUserInfo) GetFamilyNameOk() (*string, bool)

GetFamilyNameOk returns a tuple with the FamilyName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFamilyName

func (o *OidcUserInfo) SetFamilyName(v string)

SetFamilyName sets FamilyName field to given value.

HasFamilyName

func (o *OidcUserInfo) HasFamilyName() bool

HasFamilyName returns a boolean if a field has been set.

GetGender

func (o *OidcUserInfo) GetGender() string

GetGender returns the Gender field if non-nil, zero value otherwise.

GetGenderOk

func (o *OidcUserInfo) GetGenderOk() (*string, bool)

GetGenderOk returns a tuple with the Gender field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetGender

func (o *OidcUserInfo) SetGender(v string)

SetGender sets Gender field to given value.

HasGender

func (o *OidcUserInfo) HasGender() bool

HasGender returns a boolean if a field has been set.

GetGivenName

func (o *OidcUserInfo) GetGivenName() string

GetGivenName returns the GivenName field if non-nil, zero value otherwise.

GetGivenNameOk

func (o *OidcUserInfo) GetGivenNameOk() (*string, bool)

GetGivenNameOk returns a tuple with the GivenName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetGivenName

func (o *OidcUserInfo) SetGivenName(v string)

SetGivenName sets GivenName field to given value.

HasGivenName

func (o *OidcUserInfo) HasGivenName() bool

HasGivenName returns a boolean if a field has been set.

GetLocale

func (o *OidcUserInfo) GetLocale() string

GetLocale returns the Locale field if non-nil, zero value otherwise.

GetLocaleOk

func (o *OidcUserInfo) GetLocaleOk() (*string, bool)

GetLocaleOk returns a tuple with the Locale field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLocale

func (o *OidcUserInfo) SetLocale(v string)

SetLocale sets Locale field to given value.

HasLocale

func (o *OidcUserInfo) HasLocale() bool

HasLocale returns a boolean if a field has been set.

GetMiddleName

func (o *OidcUserInfo) GetMiddleName() string

GetMiddleName returns the MiddleName field if non-nil, zero value otherwise.

GetMiddleNameOk

func (o *OidcUserInfo) GetMiddleNameOk() (*string, bool)

GetMiddleNameOk returns a tuple with the MiddleName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMiddleName

func (o *OidcUserInfo) SetMiddleName(v string)

SetMiddleName sets MiddleName field to given value.

HasMiddleName

func (o *OidcUserInfo) HasMiddleName() bool

HasMiddleName returns a boolean if a field has been set.

GetName

func (o *OidcUserInfo) GetName() string

GetName returns the Name field if non-nil, zero value otherwise.

GetNameOk

func (o *OidcUserInfo) GetNameOk() (*string, bool)

GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetName

func (o *OidcUserInfo) SetName(v string)

SetName sets Name field to given value.

HasName

func (o *OidcUserInfo) HasName() bool

HasName returns a boolean if a field has been set.

GetNickname

func (o *OidcUserInfo) GetNickname() string

GetNickname returns the Nickname field if non-nil, zero value otherwise.

GetNicknameOk

func (o *OidcUserInfo) GetNicknameOk() (*string, bool)

GetNicknameOk returns a tuple with the Nickname field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetNickname

func (o *OidcUserInfo) SetNickname(v string)

SetNickname sets Nickname field to given value.

HasNickname

func (o *OidcUserInfo) HasNickname() bool

HasNickname returns a boolean if a field has been set.

GetPhoneNumber

func (o *OidcUserInfo) GetPhoneNumber() string

GetPhoneNumber returns the PhoneNumber field if non-nil, zero value otherwise.

GetPhoneNumberOk

func (o *OidcUserInfo) GetPhoneNumberOk() (*string, bool)

GetPhoneNumberOk returns a tuple with the PhoneNumber field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPhoneNumber

func (o *OidcUserInfo) SetPhoneNumber(v string)

SetPhoneNumber sets PhoneNumber field to given value.

HasPhoneNumber

func (o *OidcUserInfo) HasPhoneNumber() bool

HasPhoneNumber returns a boolean if a field has been set.

GetPhoneNumberVerified

func (o *OidcUserInfo) GetPhoneNumberVerified() bool

GetPhoneNumberVerified returns the PhoneNumberVerified field if non-nil, zero value otherwise.

GetPhoneNumberVerifiedOk

func (o *OidcUserInfo) GetPhoneNumberVerifiedOk() (*bool, bool)

GetPhoneNumberVerifiedOk returns a tuple with the PhoneNumberVerified field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPhoneNumberVerified

func (o *OidcUserInfo) SetPhoneNumberVerified(v bool)

SetPhoneNumberVerified sets PhoneNumberVerified field to given value.

HasPhoneNumberVerified

func (o *OidcUserInfo) HasPhoneNumberVerified() bool

HasPhoneNumberVerified returns a boolean if a field has been set.

GetPicture

func (o *OidcUserInfo) GetPicture() string

GetPicture returns the Picture field if non-nil, zero value otherwise.

GetPictureOk

func (o *OidcUserInfo) GetPictureOk() (*string, bool)

GetPictureOk returns a tuple with the Picture field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPicture

func (o *OidcUserInfo) SetPicture(v string)

SetPicture sets Picture field to given value.

HasPicture

func (o *OidcUserInfo) HasPicture() bool

HasPicture returns a boolean if a field has been set.

GetPreferredUsername

func (o *OidcUserInfo) GetPreferredUsername() string

GetPreferredUsername returns the PreferredUsername field if non-nil, zero value otherwise.

GetPreferredUsernameOk

func (o *OidcUserInfo) GetPreferredUsernameOk() (*string, bool)

GetPreferredUsernameOk returns a tuple with the PreferredUsername field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPreferredUsername

func (o *OidcUserInfo) SetPreferredUsername(v string)

SetPreferredUsername sets PreferredUsername field to given value.

HasPreferredUsername

func (o *OidcUserInfo) HasPreferredUsername() bool

HasPreferredUsername returns a boolean if a field has been set.

GetProfile

func (o *OidcUserInfo) GetProfile() string

GetProfile returns the Profile field if non-nil, zero value otherwise.

GetProfileOk

func (o *OidcUserInfo) GetProfileOk() (*string, bool)

GetProfileOk returns a tuple with the Profile field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetProfile

func (o *OidcUserInfo) SetProfile(v string)

SetProfile sets Profile field to given value.

HasProfile

func (o *OidcUserInfo) HasProfile() bool

HasProfile returns a boolean if a field has been set.

GetSub

func (o *OidcUserInfo) GetSub() string

GetSub returns the Sub field if non-nil, zero value otherwise.

GetSubOk

func (o *OidcUserInfo) GetSubOk() (*string, bool)

GetSubOk returns a tuple with the Sub field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSub

func (o *OidcUserInfo) SetSub(v string)

SetSub sets Sub field to given value.

HasSub

func (o *OidcUserInfo) HasSub() bool

HasSub returns a boolean if a field has been set.

GetUpdatedAt

func (o *OidcUserInfo) GetUpdatedAt() int64

GetUpdatedAt returns the UpdatedAt field if non-nil, zero value otherwise.

GetUpdatedAtOk

func (o *OidcUserInfo) GetUpdatedAtOk() (*int64, bool)

GetUpdatedAtOk returns a tuple with the UpdatedAt field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUpdatedAt

func (o *OidcUserInfo) SetUpdatedAt(v int64)

SetUpdatedAt sets UpdatedAt field to given value.

HasUpdatedAt

func (o *OidcUserInfo) HasUpdatedAt() bool

HasUpdatedAt returns a boolean if a field has been set.

GetWebsite

func (o *OidcUserInfo) GetWebsite() string

GetWebsite returns the Website field if non-nil, zero value otherwise.

GetWebsiteOk

func (o *OidcUserInfo) GetWebsiteOk() (*string, bool)

GetWebsiteOk returns a tuple with the Website field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetWebsite

func (o *OidcUserInfo) SetWebsite(v string)

SetWebsite sets Website field to given value.

HasWebsite

func (o *OidcUserInfo) HasWebsite() bool

HasWebsite returns a boolean if a field has been set.

GetZoneinfo

func (o *OidcUserInfo) GetZoneinfo() string

GetZoneinfo returns the Zoneinfo field if non-nil, zero value otherwise.

GetZoneinfoOk

func (o *OidcUserInfo) GetZoneinfoOk() (*string, bool)

GetZoneinfoOk returns a tuple with the Zoneinfo field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetZoneinfo

func (o *OidcUserInfo) SetZoneinfo(v string)

SetZoneinfo sets Zoneinfo field to given value.

HasZoneinfo

func (o *OidcUserInfo) HasZoneinfo() bool

HasZoneinfo returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]