Skip to content

You're viewing documentation for a pre-release version. View the latest stable version

Instance Property

preferredUsername

The primary username that represents the user. It could be an email address, phone number, or a generic username without a specified format. Its value is mutable and might change over time. Since it is mutable, this value must not be used to make authorization decisions. The profile scope is required to receive this claim.
let preferredUsername: String?