Skip to main content
GET
Retrieve the profile information for the currently authenticated user. This endpoint returns user details, metadata, and account status.
This endpoint requires authentication. Include the Bearer token in the Authorization header.

Response

string
Unique user identifier (UUID)
string
Audience claim (typically your application identifier)
string
User role (e.g., “authenticated”, “admin”)
string
User’s email address
string
ISO timestamp when email was confirmed (null if not confirmed)
string
User’s phone number in E.164 format
string
ISO timestamp when phone was confirmed (null if not confirmed)
string
ISO timestamp when user account was confirmed
string
ISO timestamp of last successful sign-in
object
Application-specific metadata (managed by your application)
object
User-specific metadata (can be updated by user)
array
Array of identity providers linked to this user
string
ISO timestamp when user account was created
string
ISO timestamp when user account was last updated

Error Responses

Implementation Examples

React User Profile Component

React Hook for User Data

Node.js Backend Handler

Authentication Middleware

User Metadata Structure

App Metadata (Read-only)

App metadata is managed by your application and cannot be modified by users:

User Metadata (User-modifiable)

User metadata can be updated by users through the update profile endpoint:

Security Considerations

  • Token Validation: Always validate JWT tokens server-side
  • Scope Limitations: Users can only access their own profile data
  • Sensitive Data: Never expose sensitive information in user metadata
  • Rate Limiting: Implement rate limiting for profile access
  • Audit Logging: Log profile access for security monitoring

Best Practices

  • Cache user data appropriately to reduce API calls
  • Handle token expiration gracefully with automatic refresh
  • Provide loading states for better user experience
  • Implement error boundaries for robust error handling
  • Use TypeScript for better type safety
  • Validate JWT tokens on every request
  • Implement proper error handling and logging
  • Use middleware for authentication logic
  • Cache user data when appropriate
  • Monitor API usage and performance
  • Keep user metadata lean and relevant
  • Use app metadata for application-specific data
  • Implement data validation for user inputs
  • Consider GDPR compliance for user data
  • Regular cleanup of unused metadata fields

Testing

Unit Tests

Update Profile

Update user profile information

User Logout

Sign out and invalidate tokens

Refresh Token

Refresh expired access tokens

Delete Account

Delete user account permanently