Appearance

Documentation / server-auth / User

Interface: User ​

Properties ​

apple? ​

apple?: Omit<AppleOAuthWithMetadata, "type">

The user's Apple account, if they have linked one. It cannot be linked to another user.

createdAt ​

createdAt: Date

The datetime of when the user was created.

custom? ​

custom?: Omit<CustomJwtWithMetadata, "type">

The user's Custom JWT account, if they have linked one. It cannot be linked to another user.

customMetadata ​

customMetadata: Record<string, string | number | boolean>

Custom metadata set for the user

discord? ​

discord?: Omit<DiscordOAuthWithMetadata, "type">

The user's Discord account, if they have linked one. It cannot be linked to another user.

email? ​

email?: Omit<EmailWithMetadata, "type">

The user's email address, if they have linked one. It cannot be linked to another user.

farcaster? ​

farcaster?: Omit<FarcasterWithMetadata, "type">

The user's Farcaster account, if they have linked one. It cannot be linked to another user.

github? ​

github?: Omit<GithubOAuthWithMetadata, "type">

The user's Github account, if they have linked one. It cannot be linked to another user.

google? ​

google?: Omit<GoogleOAuthWithMetadata, "type">

The user's Google account, if they have linked one. It cannot be linked to another user.

id ​

id: string

The Privy-issued DID for the user. If you need to store additional information about a user, you can use this DID to reference them.

instagram? ​

instagram?: Omit<InstagramOAuthWithMetadata, "type">

The user's Instagram account, if they have linked one. It cannot be linked to another user.

isGuest ​

isGuest: boolean

Whether or not the user is a guest.

linkedAccounts ​

linkedAccounts: LinkedAccountWithMetadata[]

The list of accounts associated with this user. Each account contains additional metadata that may be helpful for advanced use cases.

linkedin? ​

linkedin?: Omit<LinkedInOAuthWithMetadata, "type">

The user's LinkedIn account, if they have linked one. It cannot be linked to another user.

phone? ​

phone?: Omit<PhoneWithMetadata, "type">

The user's phone number, if they have linked one. It cannot be linked to another user.

smartWallet? ​

smartWallet?: Omit<SmartWalletWithMetadata, "type">

The user's smart wallet, if they have set up through the Privy Smart Wallet SDK.

spotify? ​

spotify?: Omit<SpotifyOAuthWithMetadata, "type">

The user's Spotify account, if they have linked one. It cannot be linked to another user.

telegram? ​

telegram?: Omit<TelegramWithMetadata, "type">

The user's Telegram account, if they have linked one. It cannot be linked to another user.

tiktok? ​

tiktok?: Omit<TiktokOAuthWithMetadata, "type">

The user's Tiktok account, if they have linked one. It cannot be linked to another user.

twitter? ​

twitter?: Omit<TwitterOAuthWithMetadata, "type">

The user's Twitter account, if they have linked one. It cannot be linked to another user.

wallet? ​

wallet?: Omit<WalletWithMetadata, "type">

The user's most recently-linked wallet address, if they have linked at least one wallet. It cannot be linked to another user.