useStytchUser Hook - Stytch Docs

import { Text } from 'react-native';
import { useStytchUser } from '@stytch/react-native';

export const Home = () => {
  const { user } = useStytchUser();

  return user ? <Text>Welcome, {user.name.first_name}</Text> : <Text>Log in to continue!</Text>;
};

{
  "user": { ... },
  "fromCache": false
}

{
  "user": null,
  "fromCache": false
}

import { Text } from 'react-native';
import { useStytchUser } from '@stytch/react-native';

export const Home = () => {
  const { user } = useStytchUser();

  return user ? <Text>Welcome, {user.name.first_name}</Text> : <Text>Log in to continue!</Text>;
};

{
  "user": { ... },
  "fromCache": false
}

{
  "user": null,
  "fromCache": false
}

import { Text } from 'react-native';
import { useStytchUser } from '@stytch/react-native';

export const Home = () => {
  const { user } = useStytchUser();

  return user ? <Text>Welcome, {user.name.first_name}</Text> : <Text>Log in to continue!</Text>;
};

{
  "user": { ... },
  "fromCache": false
}

{
  "user": null,
  "fromCache": false
}

To get the currently signed in User, use the 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

user

object | null

The current User.

Show properties

created_at

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.

crypto_wallets

array[objects]

An array contains a list of all crypto wallets for a given User in the Stytch API.

Show properties

crypto_wallet_id

string

The unique ID for a crypto wallet

crypto_wallet_address

string

The actual blockchain address of the User’s crypto wallet.

crypto_wallet_type

string

The blockchain that the User’s crypto wallet operates on, e.g. Ethereum, Solana, etc.

verified

boolean

If this method has been successfully authenticated by the User.

emails

array[objects]

An array of email objects for the User.

Show properties

email_id

string

The unique ID of a specific email address.

string

The email address.

verified

boolean

If this method has been successfully authenticated by the User.

name

object

The name of the User. Each field in the name object is optional.

Show properties

first_name

string

The first name of the user.

middle_name

string

The middle name(s) of the user.

last_name

string

The last name of the user.

trusted_metadata

object

The trusted_metadata field contains an arbitrary JSON object of application-specific data. See the Metadata reference for complete field behavior details.

untrusted_metadata

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.

phone_numbers

array[objects]

An array of phone number objects linked to the User.

Show properties

phone_id

string

The unique ID for the phone number.

phone_number

string

The phone number.

verified

boolean

If this method has been successfully authenticated by the User.

providers

array[objects]

An array of OAuth provider objects linked to the User.

Show properties

oauth_user_registration_id

string

The unique ID for an OAuth registration.

provider_subject

string

The unique identifier for the User within a given OAuth provider. Also commonly called the “sub” or “Subject field” in OAuth protocols.

provider_type

string

Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Facebook, GitHub etc.

profile_picture_url

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.

locale

string

If available, the locale is the User’s locale set in the OAuth identity provider that the user has authenticated with.

password

object

The password object is returned for users with a password.

Show properties

password_id

string

The unique ID of a specific password

requires_reset

boolean

Indicates whether this password requires a password reset

status

string

The status of the User. The possible values are pending and active.

totps

array[objects]

An array containing a list of all TOTP instances for a given User in the Stytch API.

Show properties

totp_id

string

The unique ID for a TOTP instance.

verified

boolean

If this method has been successfully authenticated by the User.

user_id

string

The unique ID of the affected User.

webauthn_registrations

array[objects]

An array that contains a list of all Passkey or WebAuthn registrations for a given User in the Stytch API.

Show properties

webauthn_registration_id

string

The unique ID for the Passkey or WebAuthn registration.

domain

string

The domain on which Passkey or WebAuthn registration was started. This will be the domain of your app.

user_agent

string

The user agent of the User.

authenticator_type

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.

verified

boolean

If this method has been successfully authenticated by the User.

name

string

The name of the Passkey or WebAuthn registration.

biometric_registrations

array[objects]

An array that contains a list of all biometric registrations for a given User in the Stytch API.

Show properties

biometric_registration_id

string

The unique ID for a biometric registration.

verified

boolean

If this method has been successfully authenticated by the User.

roles

array[strings]

Roles assigned to this User. See the RBAC guide for more information about role assignment.

fromCache

boolean

Whether the User data is from persistent storage.

⌘I

​Return Value

Return Value