Skip to content

useUser

Access the current authenticated user and refresh authentication tokens.

Usage

import { useUser } from '@openfort/react';
 
function Profile() {
  const { user, isAuthenticated, getAccessToken } = useUser();
 
  if (!isAuthenticated) return <SignIn />;
 
  return <div>{user?.player?.name}</div>;
}

Return type

type UseUserReturn = {
  user: AuthPlayerResponse | null  // Current user object
  isAuthenticated: boolean         // Whether user is logged in
  getAccessToken(): Promise<string | null>  // Get current access token
  validateAndRefreshToken(): Promise<void>  // Force token refresh
}
 
type AuthPlayerResponse = {
  id: string
  object: 'player'
  createdAt: number
  linkedAccounts: LinkedAccount[]
  player?: {
    id: string
    name: string
    metadata?: Record<string, any>
  }
}
 
type LinkedAccount = {
  provider: string
  email?: string
  address?: string
  verified?: boolean
  disabled: boolean
}