Interface: UserInfo
Represents a successful response to a Get User Info operation.
Export
UserInfo
Properties
about_me?
optionalabout_me:string
A short description written by the user to introduce themselves, as specified in the user’s profile.
Memberof
UserInfo
Defined in
address?
optionaladdress:UserInfoAddress
Memberof
UserInfo
Defined in
company?
optionalcompany:string
The company that the user works for, as specified in the user’s profile.
Memberof
UserInfo
Defined in
country_code?
optionalcountry_code:string
The ISO 3166 country code that was assigned to the user when their profile was created.
Memberof
UserInfo
Defined in
created_date?
optionalcreated_date:string
The time the user profile was created, represented as a Unix timestamp.
Memberof
UserInfo
Defined in
eidm_guid?
optionaleidm_guid:string
An ID to uniquely identify the user. For most users this will be the same as sub. However, for users profiles created on the now retired EIDM system eidm_guid will be different from sub.
Memberof
UserInfo
Defined in
email?
optionalemail:string
The email address by which the user prefers to be contacted.
Memberof
UserInfo
Defined in
email_verified?
optionalemail_verified:boolean
true : The user’s preferred email address is verified.
false: The user’s preferred email address is not verified.
Memberof
UserInfo
Defined in
family_name?
optionalfamily_name:string
The surname or last name of the user.
Memberof
UserInfo
Defined in
given_name?
optionalgiven_name:string
The given name or first name of the user.
Memberof
UserInfo
Defined in
industry?
optionalindustry:string
The industry the user works in, as specified in the user’s profile.
Memberof
UserInfo
Defined in
industry_code?
optionalindustry_code:string
A code that corresponds to the industry.
Memberof
UserInfo
Defined in
is_2fa_enabled?
optionalis_2fa_enabled:boolean
true: Two-factor authentication is enabled for this user.
false: Two-factor authentication is not enabled for this user.
Memberof
UserInfo
Defined in
job_title?
optionaljob_title:string
The job title of the user as specified in the user’s profile.
Memberof
UserInfo
Defined in
language?
optionallanguage:string
The ISO 639 language code of the preferred language of the user.
Memberof
UserInfo
Defined in
last_login_date?
optionallast_login_date:string
The time the user most recently signed-in to APS successfully, represented as a Unix timestamp.
Memberof
UserInfo
Defined in
ldap_domain?
optionalldap_domain:string
The domain name used by the LDAP server for user authentication. null, if ldap_enabled is false.
Memberof
UserInfo
Defined in
ldap_enabled?
optionalldap_enabled:boolean
true : Single sign-on using Lightweight Directory Access Protocol (LDAP) is enabled for this user.
false : LDAP is not enabled for this user.
Memberof
UserInfo
Defined in
locale?
optionallocale:string
The preferred language settings of the user. This setting is typically specified as a combination of the ISO 639 language code in lower case, and the ISO 3166 country code in upper case, separated by a dash character. For example en-US.
Memberof
UserInfo
Defined in
name?
optionalname:string
The full name of the user.
Memberof
UserInfo
Defined in
opt_in?
optionalopt_in:boolean
true : The user has agreed to receive marketing information.
false: The user does not want to receive marketing information.
Memberof
UserInfo
Defined in
phone_number?
optionalphone_number:string
The phone number by which the user prefers to be contacted.
Memberof
UserInfo
Defined in
phone_number_verified?
optionalphone_number_verified:boolean
true : The phone number is verified.
false : The phone number is not verified.
Memberof
UserInfo
Defined in
picture?
optionalpicture:string
The URL of the profile picture of the user.
Memberof
UserInfo
Defined in
preferred_username?
optionalpreferred_username:string
The username by which the user prefers to be addressed.
Memberof
UserInfo
Defined in
profile?
optionalprofile:string
The URL of the profile page of the user.
Memberof
UserInfo
Defined in
sub?
optionalsub:string
The ID by which APS uniquely identifies the user.
Memberof
UserInfo
Defined in
thumbnails?
optionalthumbnails:object
An array of key-value pairs containing image URLs for various thumbnail sizes of the user’s profile picture. The key is named sizeX<NUMBER> where <NUMBER> is the width and height of the thumbnail, in pixels. The corresponding value is the URL pointing to the thumbnail. For example, sizeX200 would contain the URL for the 200x200 pixel thumbnail.
Index Signature
[key: string]: string
Memberof
UserInfo
Defined in
updated_at?
optionalupdated_at:number
The time the user’s information was most recently updated, represented as a Unix timestamp.
Memberof
UserInfo
social_userinfo_list?
An array of objects, where each object represents a social media account that can be used to verify the user’s identity.
Memberof
UserInfo
Defined in
model/userInfo.ts:199