Skip to content

Documentation / react-auth / User

Interface: User

Properties

apple?

apple?: Apple

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.


customMetadata?

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

Custom metadata field for a given user account


discord?

discord?: Discord

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


email?

email?: Email

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


farcaster?

farcaster?: Farcaster

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


github?

github?: Github

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


google?

google?: Google

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


hasAcceptedTerms

hasAcceptedTerms: boolean

Whether or not the user has explicitly accepted the Terms and Conditions and/or Privacy Policy


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?: Instagram

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?: LinkedIn

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


mfaMethods

mfaMethods: ("sms" | "totp" | "passkey")[]

The list of MFA Methods associated with this user.


phone?

phone?: Phone

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


smartWallet?

smartWallet?: SmartWallet

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


spotify?

spotify?: Spotify

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


telegram?

telegram?: Telegram

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


tiktok?

tiktok?: Tiktok

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


twitter?

twitter?: Twitter

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


wallet?

wallet?: Wallet

The user's most recently linked wallet, if they have linked at least one wallet. It cannot be linked to another user. This wallet is the wallet that will be used for transactions and signing if it is connected.