UserInfo

public struct UserInfo : JSONObjectPayload

OIDC Standard Claims user information.

See

Claims
  • The list of public claims.

    Declaration

    Swift

    public static let publicClaims: [String]

Claims

  • sub

    The Auth0 user identifier.

    Declaration

    Swift

    public let sub: String
  • The name of the user.

    Requires

    The profile scope.

    Declaration

    Swift

    public let name: String?
  • The first name of the user.

    Requires

    The profile scope.

    Declaration

    Swift

    public let givenName: String?
  • The last name of the user.

    Requires

    The profile scope.

    Declaration

    Swift

    public let familyName: String?
  • The middle name of the user.

    Requires

    The profile scope.

    Declaration

    Swift

    public let middleName: String?
  • The nickname of the user.

    Requires

    The profile scope.

    Declaration

    Swift

    public let nickname: String?
  • The preferred username of the user.

    Requires

    The profile scope.

    Declaration

    Swift

    public let preferredUsername: String?
  • The URL of the user’s profile page.

    Requires

    The profile scope.

    Declaration

    Swift

    public let profile: URL?
  • The URL of the user’s picture.

    Requires

    The profile scope.

    Declaration

    Swift

    public let picture: URL?
  • The URL of the user’s website.

    Requires

    The profile scope.

    Declaration

    Swift

    public let website: URL?
  • The email of the user.

    Requires

    The email scope.

    Declaration

    Swift

    public let email: String?
  • If the user’s email is verified.

    Requires

    The email scope.

    Declaration

    Swift

    public let emailVerified: Bool?
  • The gender of the user.

    Requires

    The profile scope.

    Declaration

    Swift

    public let gender: String?
  • The birthdate of the user.

    Requires

    The profile scope.

    Declaration

    Swift

    public let birthdate: String?
  • The time zone of the user.

    Requires

    The profile scope.

    Declaration

    Swift

    public let zoneinfo: TimeZone?
  • The locale of the user.

    Requires

    The profile scope.

    Declaration

    Swift

    public let locale: Locale?
  • The phone number of the user.

    Requires

    The phone_number scope.

    Declaration

    Swift

    public let phoneNumber: String?
  • If the user’s phone number is verified.

    Requires

    The phone_number scope.

    Declaration

    Swift

    public let phoneNumberVerified: Bool?
  • The address of the user.

    Requires

    The address scope.

    Declaration

    Swift

    public let address: [String : String]?
  • The date and time the user’s information was last updated.

    Requires

    The profile scope.

    Declaration

    Swift

    public let updatedAt: Date?
  • Any custom claims.

    Declaration

    Swift

    public let customClaims: [String : Any]?

Initializer

  • Creates a new UserInfo from a JSON dictionary.

    Declaration

    Swift

    init?(json: [String : Any])