IPWorks Auth 2020 macOS Edition

Questions / Feedback?

UserDetails Type

This type holds details about the user.

Remarks

The fields of this type correspond to claims about the user.

Fields

addrCountry
String

This property holds the country name portion of the user's address.

addrFormatted
String

This property holds the full mailing address of the user, formatted for display or use on a mailing label. This value may contain multiple lines.

addrLocality
String

This property holds the city or locality portion of the user's address.

addrPostalCode
String

This property holds the zip code or postal code portion of the user's address.

addrRegion
String

This property holds the state, province, prefecture, or region portion of the user's address.

addrStreetAddr
String

This property holds the street address portion of the user's address. This is the full street address which may include house number, street name, post office box, and multi-line extended street information. This value may contain multiple lines.

audiences
String

This property contains a comma separated list of audiences for which the user information is intended.

birthday
String

This property contains the user's birthday. The format of the value is YYYY-MM-DD or YYYY. The year may be 0000 to indicate it was omitted.

email
String

This property contains the user's preferred email address.

emailVerified
Bool

This property indicates whether the user's email address has been verified. To be considered verified the end-user must prove the email address was under the user's control at the time of verification.

firstName
String

This property holds the first name of the user. If multiple names are present they are space separated.

gender
String

This property holds the user's gender. Defined values are male and female but other values may also be used.

issuer
String

This property contains the identifier of the issuer who issued the ID token.

lastName
String

This property holds the last name of the user. If multiple names are present they are space separated.

locale
String

This property holds the end user's locale. This is represented as a BCP47 (RFC 5646) language tag. For instance en-US or en_US.

middleName
String

This property holds the middle name of the user. If multiple names are present they are space separated.

name
String

This property contains the user's full name in displayable form including all name parts. This may include titles and suffixes.

nickname
String

This property holds the casual name of the user. This may or may not be the same as FirstName.

phoneNumber
String

This property holds the user's phone number. This may be in E.164 format, for instance +1 (425) 555-1212. If an extension is present it may be represented according to RFC 3966. For instance: +1 (604) 555-1234;ext=5678.

phoneNumberVerified
Bool

This property indicates whether the user's phone number has been verified. To be considered verified the end-user must prove the phone number was under the user's control at the time of verification.

pictureURL
String

This property holds the URL of the user's profile picture.

preferredUsername
String

This property holds the shorthand name by which the end-user wishes to be referred.

profileURL
String

This property holds the URL of the user's profile page.

subject
String

This property holds the subject identifier of the token.

tokenAuthTime
Int64

This property holds the time when authentication occurred.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

tokenExpTime
Int64

This property holds the expiration time of the token.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

tokenIssuedAt
Int64

This property holds the time when the token was issued.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

updatedAt
Int64

This property holds the time when the user's information was last updated.

The time value is a number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.

website
String

This property holds the URL of the user's website.

zoneInfo
String

This property holds the user's time zone. For instance: America/Los_Angeles.

Constructors

public init()

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 macOS Edition - Version 20.0 [Build 8155]