useStytchUser hook.
If no User is signed in, the user object will be null.
In non-React environments, use the user.getSync method to get the User.
Return Value
The current User.
Show properties
Show properties
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.
An array contains a list of all crypto wallets for a given User in the Stytch API.
Show properties
Show properties
The unique ID for a crypto wallet
The actual blockchain address of the User’s crypto wallet.
The blockchain that the User’s crypto wallet operates on, e.g. Ethereum, Solana, etc.
If this method has been successfully authenticated by the User.
The trusted_metadata field contains an arbitrary JSON object of application-specific data. See the Metadata reference for complete field behavior details.
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.
An array of OAuth provider objects linked to the User.
Show properties
Show properties
The unique ID for an OAuth registration.
The unique identifier for the User within a given OAuth provider. Also commonly called the “sub” or “Subject field” in OAuth protocols.
Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Facebook, GitHub etc.
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.
If available, the locale is the User’s locale set in the OAuth identity provider that the user has authenticated with.
The status of the User. The possible values are
pending and active.The unique ID of the affected User.
An array that contains a list of all Passkey or WebAuthn registrations for a given User in the Stytch API.
Show properties
Show properties
The unique ID for the Passkey or WebAuthn registration.
The domain on which Passkey or WebAuthn registration was started. This will be the domain of your app.
The user agent of the User.
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.
If this method has been successfully authenticated by the User.
The name of the Passkey or WebAuthn registration.
Roles assigned to this User. See the RBAC guide for more information about role assignment.
Whether the User data is from persistent storage.