The Stytch SDK caches the currently logged-in user. user.getSync is a synchronous method that fetches the currently logged-in User from the cache.If there is no cached data, this method returns null.The user.getInfo method is similar to user.getSync, but returns an object containing the user object and a fromCache boolean. If fromCache is true, the user object is from the cache and a state refresh is in progress.You can listen for changes with the user.onChange method, which invokes your callback whenever the user object changes.If you need to asynchronously fetch guaranteed-fresh data from the API, use the user.get method.
Response
object
See the User object for complete response field details.
Show properties
string
The timestamp of the User’s creation. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. 2021-12-29T12:33:09Z.
array[objects]
An array contains a list of all crypto wallets for a given User in the Stytch API.
Show properties
string
The unique ID for a crypto wallet
string
The actual blockchain address of the User’s crypto wallet.
string
The blockchain that the User’s crypto wallet operates on, e.g. Ethereum, Solana, etc.
boolean
If this method has been successfully authenticated by the User.
array[objects]
An array of email objects for the User.
Show properties
string
The unique ID of a specific email address.
string
The email address.
boolean
If this method has been successfully authenticated by the User.
object
The name of the User. Each field in the name object is optional.
Show properties
string
The first name of the user.
string
The middle name(s) of the user.
string
The last name of the user.
object
The trusted_metadata field contains an arbitrary JSON object of application-specific data. See the Metadata reference for complete field behavior details.
object
The untrusted_metadata field contains an arbitrary JSON object of application-specific data. Untrusted metadata can be edited by end users directly via the SDK, and cannot be used to store critical information. See the Metadata reference for complete field behavior details.
array[objects]
An array of phone number objects linked to the User.
Show properties
string
The unique ID for the phone number.
string
The phone number.
boolean
If this method has been successfully authenticated by the User.
array[objects]
An array of OAuth provider objects linked to the User.
Show properties
string
The unique ID for an OAuth registration.
string
The unique identifier for the User within a given OAuth provider. Also commonly called the “sub” or “Subject field” in OAuth protocols.
string
Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Facebook, GitHub etc.
string
If available, the profile_picture_url is a url of the User’s profile picture set in OAuth identity the provider that the User has authenticated with, e.g. Facebook profile picture.
string
If available, the locale is the User’s locale set in the OAuth identity provider that the user has authenticated with.
object
The password object is returned for users with a password.
Show properties
string
The unique ID of a specific password
boolean
Indicates whether this password requires a password reset
string
The status of the User. The possible values are pending and active.
array[objects]
An array containing a list of all TOTP instances for a given User in the Stytch API.
Show properties
string
The unique ID for a TOTP instance.
boolean
If this method has been successfully authenticated by the User.
string
The unique ID of the affected User.
array[objects]
An array that contains a list of all Passkey or WebAuthn registrations for a given User in the Stytch API.
Show properties
string
The unique ID for the Passkey or WebAuthn registration.
string
The domain on which Passkey or WebAuthn registration was started. This will be the domain of your app.
string
The user agent of the User.
string
The authenticator_type string displays the requested authenticator type of the Passkey or WebAuthn device. The two valid types are “platform” and “cross-platform”. If no value is present, the Passkey or WebAuthn device was created without an authenticator type preference.
boolean
If this method has been successfully authenticated by the User.
string
The name of the Passkey or WebAuthn registration.
array[objects]
An array that contains a list of all biometric registrations for a given User in the Stytch API.
Show properties
string
The unique ID for a biometric registration.
boolean
If this method has been successfully authenticated by the User.
array[strings]
Roles assigned to this User. See the RBAC guide for more information about role assignment.
boolean
Whether the User data is from persistent storage.
Assistant
Responses are generated using AI and may contain mistakes.