Skip to content
Torii
docs
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Guides
Getting started
Installation
React Quickstart
Required for production
Required
First-party cookies (proxy & CNAME)
Onboarding gates
Multi-factor authentication
User impersonation
OAuth providers
Advanced usages
Custom flows (headless)
JWT templates
Native (Capacitor) auth
User metadata
Components
Key Components
Read first
Overview
Read first
Common flows
ToriiProvider
SignIn
SignUp
Control components
UserButton
UserDashboard
When defaults aren't enough
UserProfile
MfaEnrollment
OrganizationList
Account widgets
Low-level forms
Runtime status
AuthCard
InvitationSignUp
Hooks
Key Hooks
Read first
Common flows
useAuth
useAuthFetch
When defaults aren't enough
useUser
useUserProfile
useSessions
useIdentities
useEmailAddresses
useMfaEnrollment
useOrganizations
useDataRequest
useDeleteAccount
useRuntimeStatus
Credential & flow hooks
Customization
Elements & slot overrides
Labels & i18n
Customizing Torii
Theming
API reference
Error codes
Overview
Client API
Overview
Sessions
Overview
List active sessions
Revoke all other sessions
Revoke a specific session
Data Requests
Overview
List my data requests
Request a copy of your data
Organizations (Client)
Overview
List organizations the current user belongs to
Create a new organization. The caller becomes its owner.
Set the active organization for this session.
Invite a user to an organization by email. Caller must be owner or admin.
Accept an organization invitation by its token.
Remove a member. Caller must be owner or admin, OR removing themselves (leave).
Update a member's role. Caller must be owner or admin.
Get a single organization the user belongs to
List the organization's assignable roles (for an invite / change-role picker)
List USER members of an organization the caller is a member of
Session Establish
Overview
Establish impersonation session via one-time token
Establish session cookie via one-time ticket
Redeem a native OAuth ticket for a session token
JWKS
Overview
Get JSON Web Key Set
OIDC
Overview
Get OIDC discovery document
Get OIDC discovery document
Client Boot
Overview
Boot probe
MFA
Overview
Start TOTP enrollment
Confirm TOTP enrollment
Regenerate recovery codes
Disable MFA
MFA status
OAuth2
Overview
Handle OAuth2 callback (login and identity linking)
Initiate OAuth2 login
List enabled OAuth2 providers
Signup Continuation
Overview
Get continuation state
Finalise OAuth signup
Client Environment
Overview
Get environment configuration
Users
Overview
Request account deletion
Confirm account deletion via emailed token
Get current user
Update current user profile
Sign In
Overview
Mint a token from a named JWT template
Refresh JWT
Reset password
Verify MFA challenge
Start MFA enrollment during an enforced sign-in
Confirm MFA enrollment during an enforced sign-in
Logout
Login
Forgot password
Change or set password
Get password status
Link Complete
Overview
Complete identity linking via proxy redirect
Session Sync
Overview
Satellite session sync
Sign Up
Overview
Begin sign up
Verify sign-up code
Resend sign-up code
Resend verification email
Sign up from an invitation ticket
Identities
Overview
Initiate OAuth2 identity linking
List connected identities
Unlink an identity
Email addresses
List the signed-in user's email addresses
Add an email address (sends a verification link)
Promote a verified address to primary
Re-send the verification link for a pending address
Remove a non-primary email address
Server API
Overview
Allowed Origins
Overview
List escape-hatch origins for this environment
Replace the escape-hatch origins for this environment
Server Users
Overview
Create user
Unban user
Ban user
Search users
Get user
Delete user
Update user
Update user metadata
Server Sessions
Overview
List user sessions
Revoke all sessions
Revoke specific session
Select theme
Dark
Light
Auto
Overview
Session Establish
Section titled “Session Establish”
First-party cookie establishment after OAuth2 callback
Operations
Section titled “ Operations ”
POST
/_torii/auth/session/impersonate
GET
/_torii/auth/session/establish
POST
/_torii/auth/session/establish