# useUser

Purpose [#purpose]

The `useUser` hook provides a convenient way to manage user identity and attributes, and access user-specific information like subscription status.

Returned Values [#returned-values]

<TypeTable
  type="{
  identify: {
    type: &#x22;(userId: string, options?: IdentifyOptions) => Promise<void>&#x22;,
    description: &#x22;Identifies the user with Superwall.&#x22;,
  },
  update: {
    type: &#x22;(attributes: Record<string, any | null> | ((old: Record<string, any | null>) => Record<string, any | null>)) => Promise<void>&#x22;,
    description: &#x22;Updates the current user's attributes.&#x22;,
  },
  signOut: {
    type: &#x22;() => void&#x22;,
    description: &#x22;Resets the user's identity and clears user-specific data.&#x22;,
  },
  refresh: {
    type: &#x22;() => Promise<Record<string, any>>&#x22;,
    description: &#x22;Refreshes user attributes and subscription status from Superwall.&#x22;,
  },
  setIntegrationAttributes: {
    type: &#x22;(attributes: IntegrationAttributes) => Promise<void>&#x22;,
    description: &#x22;Sets third-party integration identifiers (Adjust, Amplitude, AppsFlyer, Appstack, etc.).&#x22;,
  },
  getIntegrationAttributes: {
    type: &#x22;() => Promise<Record<string, string>>&#x22;,
    description: &#x22;Returns the currently set integration attributes.&#x22;,
  },
  getEntitlements: {
    type: &#x22;() => Promise<EntitlementsInfo>&#x22;,
    description: &#x22;Fetches the user's entitlement snapshot, including active and inactive entitlements, plus all known entitlements when exposed by the native bridge.&#x22;,
  },
  setSubscriptionStatus: {
    type: &#x22;(status: SubscriptionStatus) => Promise<void>&#x22;,
    description: &#x22;Manually sets the user's subscription status.&#x22;,
  },
  subscriptionStatus: {
    type: &#x22;SubscriptionStatus&#x22;,
    description: &#x22;Current subscription status for the user.&#x22;,
  },
  user: {
    type: &#x22;UserAttributes | null&#x22;,
    description: &#x22;Current user attributes. Null after signOut; undefined before initial load.&#x22;,
  },
}"
/>

IdentifyOptions [#identifyoptions]

<TypeTable
  type="{
  restorePaywallAssignments: {
    type: &#x22;boolean?&#x22;,
    description: &#x22;Restores paywall assignments from a previous session.&#x22;,
    default: &#x22;false&#x22;,
  },
}"
/>

SubscriptionStatus [#subscriptionstatus]

<TypeTable
  type="{
  status: {
    type: &#x22;\&#x22;UNKNOWN\&#x22; | \&#x22;INACTIVE\&#x22; | \&#x22;ACTIVE\&#x22;&#x22;,
    description: &#x22;Current subscription status value.&#x22;,
    required: true,
  },
  entitlements: {
    type: &#x22;Entitlement[]?&#x22;,
    description: &#x22;Only present when status is \&#x22;ACTIVE\&#x22;.&#x22;,
  },
}"
/>

EntitlementsInfo [#entitlementsinfo]

<TypeTable
  type="{
  all: {
    type: &#x22;Entitlement[]?&#x22;,
    description: &#x22;All entitlements known for the user. Present when the native bridge exposes the full entitlement set.&#x22;,
  },
  active: {
    type: &#x22;Entitlement[]&#x22;,
    description: &#x22;Entitlements that are currently active.&#x22;,
    required: true,
  },
  inactive: {
    type: &#x22;Entitlement[]&#x22;,
    description: &#x22;Entitlements that are known but not currently active.&#x22;,
    required: true,
  },
}"
/>

UserAttributes [#userattributes]

<TypeTable
  type="{
  aliasId: {
    type: &#x22;string&#x22;,
    description: &#x22;Alias ID for the user.&#x22;,
  },
  appUserId: {
    type: &#x22;string&#x22;,
    description: &#x22;Application-specific user ID.&#x22;,
  },
  applicationInstalledAt: {
    type: &#x22;string&#x22;,
    description: &#x22;ISO date string for when the app was installed.&#x22;,
  },
  seed: {
    type: &#x22;number&#x22;,
    description: &#x22;Seed used for experiment assignment.&#x22;,
  },
  &#x22;[key: string]&#x22;: {
    type: &#x22;any | null&#x22;,
    description: &#x22;Other custom user attributes. Values may be null.&#x22;,
  },
}"
/>

Usage [#usage]

[Managing Users](/docs/expo/guides/managing-users)