/Docs
Resources
  • Docs
  • Articles
  • Blog
  • Release Notes
  • Install
Log In
Resources
  • Docs
  • Articles
  • Blog
  • Release Notes
  • Install
🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/reference.md.

Reference

Edit on GitHubEditMD
Edit on GitHubEdit
View Markdown

This section contains reference information about FusionAuth.

API#

API Endpoints

Types and Fields#

Authentication Types

Data Types

Indexed Entity Fields

Indexed User Fields

Configuration#

Configuration

GDPR Compliance

Cookies

Network Hostnames

Password-Hashing Algorithms

On this page

  • API
  • Types and Fields
  • Configuration
Get Started
Install
DockerFirst Time SetupUpgradefusionauth-appInstall a DatabaseInstall a Search EngineStart & Stop
Development
Access from the InternetAPI MCP ServerDocs MCP ServerKickstart
Kubernetes
Deploy with k8sElastic Kubernetes Service (EKS)Google Kubernetes Engine (GKE)Local Cluster with minikubeMicrosoft Azure Kubernetes Service (AKS)
Install Reference
Air-gappingCollected MetricsCustomize Docker ImagesFusionAuth Account PortalPackagesServer LayoutSilent ModeSystem Requirements
Product Tour
Step 1 - Install FusionAuthStep 2 - Login ButtonStep 3 - Protected PagesStep 4 - Role-Based Access ControlStep 5 - Session ManagementStep 6 - LogoutStep 7 - TestingStep 8 - Finished
QuickStarts
Web
Express.NETDrupalGolangLaravelNext.jsNuxtPHPPython DjangoPython FlaskRemixRuby on RailsRust with ActixSpring Boot With ThymeleafWordPress
Single-page App
ReactAngularVue.js
App
Android Java - AppAuthAndroid Kotlin - Fusionauth SDKFlutteriOS Swift - AppAuthiOS Swift - FusionAuth SDKReact Native
API
.NET APIGolang APILaravel APINode.js/Express.js APIRuby on Rails APISpring Boot API
Core Concepts
ApplicationsOAuth ScopesTenantsUsersEntity ManagementGroupsRegistrationsRolesTypesAuthentication and AuthorizationIdentity ProvidersIntegration PointsLocalization and InternationalizationLogin Pages - Hosted or APILicensingLimitationsPlans and FeaturesPremium Features
Run in the Cloud
Disaster RecoveryFusionAuth CloudGitHub Actions
Marketplaces
AWSDigitalOceanGitHub ActionsGoogle CloudRender
Use Cases
Auth as a ServiceApp SuiteBusiness To Business To ConsumerBusiness To Business To EmployeeMachine To Machine CommunicationIdentity BrokerAuthorization HubAPI Consents Platform
Customize
Themes
Customize Advanced Themes
Upgrade an Advanced ThemeAdvanced Theme Upgrade NotesTheme ExamplesAdd a Theme to a KickstartTailwind CSSTheme Template VariablesThemes Helper Macros
Simple Theme EditorApplication-Specific ThemesClient-side Password Rule ValidationTheme Localization
Email & Messages
Application Email TemplatesGeneric MessengerMessengersSend Messages with TwilioConfigure SMTPEmail TemplatesEmail VariablesMessage TemplatesMessage Variables
Pre-1.26 2FA
Twilio IntegrationTwo-Factor with Google AuthenticatorTwo-Factor with Twilio Push Notifications
FusionAuth CLI
Operate
Deploy
FusionAuth and ProxiesFusionAuth And TerraformFusionAuth Cluster SetupUpgrade FusionAuthUser Support Guide
Monitor
CloudWatchDatadogElasticOpenTelemetryPrometheus, Loki, And GrafanaSlackSplunk
Roadmap
Deprecation PolicyReleases
Secure
Advanced Threat DetectionBreached Password DetectionCompliance FrameworksCORS ReferenceKey MasterKey RotationNetworking ConfigurationToken Storage
Troubleshooting
Technical Support
Extend
Events & Webhooks
Events
Audit Log CreateEvent Log Create
JWT
Public Key UpdateRefreshRefresh Token Revoke
Kickstart Success
Group
CreateCreate CompleteDeleteDelete CompleteMember AddMember Add CompleteMember RemoveMember Remove CompleteMember UpdateMember Update CompleteUpdateUpdate Complete
User
ActionBulk CreateCreateCreate CompleteDeactivateDeleteDelete CompleteEmail UpdateEmail VerifiedIdentity Provider LinkIdentity Provider UnlinkIdentity VerifiedReactivateTwo Factor ChallengeTwo Factor Failed AttemptTwo Factor SuccessTwo-factor Method AddTwo-factor Method RemoveUpdateUpdate Complete
Login
FailedId Duplicate CreateId Duplicate UpdateNew DeviceSuccessSuspicious
Password
BreachReset SendReset StartReset SuccessUpdate
Registration
CreateCreate CompleteDeleteDelete CompleteUpdateUpdate CompleteVerified
Kafka IntegrationSecure WebhooksSign WebhooksWebhook Event LogWrite a Webhook
Fine-Grained Authorization
Code
Lambdas
Call an API from a LambdaTest LambdasClient Credentials JWT Populate LambdaJWT Populate LambdaLogin Validation LambdaMFA Requirement LambdaSAML v2 Populate LambdaSCIM Group Request Converter LambdaSCIM Group Response Converter LambdaSCIM User Request Converter LambdaSCIM User Response Converter LambdaSelf-Service Registration Validation LambdaUserInfo Populate Lambda
Reconcile
Apple Reconcile LambdaEpic Games Reconcile LambdaExternal JWT Reconcile LambdaFacebook Reconcile LambdaGoogle Reconcile LambdaHYPR Reconcile LambdaLDAP Connector Reconcile LambdaLinkedIn Reconcile LambdaNintendo Reconcile LambdaOpenID Connect Reconcile LambdaSAML v2 Reconcile LambdaSony PlayStation Network Reconcile LambdaSteam Reconcile LambdaTwitch Reconcile LambdaTwitter Reconcile LambdaXbox Reconcile Lambda
Plugins
Custom Password HashingWriting a Plugin
Examples
5 Minute Intro
Docker InstallFast Path InstallSandbox
API Gateways
Amazon API GatewayCloudflare Worker Functions (API Gateway)HAProxy API GatewayKong Gatewayngrok Cloud EdgeSecuring your APIs with FusionAuth
Control MCP Server AccessDevice LimitingExample ApplicationsModeling HierarchiesModeling OrganizationsMulti-Application DashboardMulti-tenancyTwilio Segment
Lifecycle
Migrate Users
Connectors
FusionAuth ConnectorGeneric ConnectorLDAP Connector
Export from FusionAuthGeneric Migration Tutorial
SCIM
Azure AD SCIM ClientOkta SCIM ClientSCIM-SDK
Framework Specific
Migrate From PassportMigrate From Rails
Provider Specific
Migrate From AkamaiMigrate From Amazon CognitoMigrate From Auth0Migrate From Duende IdentityServerMigrate From FirebaseMigrate From ForgerockMigrate From FronteggMigrate From KeycloakMigrate From Microsoft Azure AD B2CMigrate From Ping IdentityMigrate From StytchMigrate From SupabaseMigrate From UserfrontMigrate From WordPress
Register Users
Advanced Registration FormsAnonymous UsersComplete RegistrationRegister A User And LoginSelf-service Registration
Authenticate Users
Add an Identity Provider (IdP)
Add an OpenID Connect IdPAdd an External SAML v2 IdP
Add an External JWT IdP
External JWT IdP Example Usage
Enterprise
Add a HYPR IdPAdd a OpenID Connect with Cognito IdPAdd a SAML v2 IdP-Initiated IdPAdd a SAML v2 IdP-Initiated with Okta IdPAdd a SAML v2 with ADFS IdPAdd a SAML v2 with Azure AD IdPAdd a SAML v2 with Okta IdPAdd an OpenID Connect with Azure AD IdPAdd an OpenID Connect with Okta IdP
Gaming
Add a Nintendo IdPAdd a Sony PlayStation Network IdPAdd a Steam IdPAdd a Twitch IdPAdd an Epic Games IdPAdd an OpenID Connect with Discord IdPAdd an Xbox IdP
Social
Add a Facebook IdPAdd a Github IdPAdd a Google IdPAdd a LinkedIn IdPAdd a Twitter/X IdPAdd an Apple IdP
Build a Login Page with the Login API
JSON Web Tokens
OAuth
Access Control with OAuth ScopesManage Software TokensModesOAuth DPoPOIDC PromptURL Validation
Passwordless Login Overview
Authentication With Magic Links & One-Time PasswordsAuthentication With WebAuthn & PasskeysConfigure WebAuthn
Application Authentication TokensContextual Multi-Factor Authentication (MFA)Host a SAML v2 Identity ProviderImplementing Single Sign-onLogout And Session ManagementMulti-Factor Authentication (MFA)Risk SignalsSetting Up User Account Lockout
Integrations
OpenID Connect Integrations
OIDC & CockroachDBOIDC & SalesforceOIDC & Tableau Cloud
SAML
SAML v2 & AivenSAML v2 & GoogleSAML v2 & PagerDutySAML v2 & SendGridSAML v2 & Tableau CloudSAML v2 & Zendesk
Manage Users
Self-Service Account Management
Account TroubleshootingAdd Authenticator as a second factorAdd Email as a second factorAdd Phone as a second factorAdd WebAuthn PasskeyBootstrapping Login For Self-Service Account ManagementCustomizing Self-Service Account ManagementUpdate User Profiles and Passwords
Tenant Manager AppCleanSpeak IntegrationCustom Admin FormsHow To Use User Actions
Search
Searching Users With Elasticsearch or OpenSearchSwitching Search Engines
Verification
Gate Users Application RegistrationGate Users Until They Verify Their EmailGate Users Until They Verify Their PhoneIdentity Pre-Verification Using Email Verification FormIdentity Pre-Verification Using Phone Verification FormIdentity Pre-Verification Via APIRegistration-based Email Verification
Client Libraries and SDKs
Example Apps
.NET Core Example AppsGo Example AppsJava Example AppsPHP Example AppsPython Example AppsRuby Example AppsTypescript, Node and JavaScript Example Apps
OpenAPI SpecificationReact SDKVue SDKAngular SDKKotlin SDK for AndroidSwift SDK for iOS.NET Core Client LibraryGo Client LibraryJava Client LibraryPHP Client LibraryPython Client LibraryRuby Client LibraryTypescript Client Library
Reference
API Endpoints Guarded by API KeysAuthentication TypesConfiguration ReferenceData TypesGDPR ComplianceIndexed Entity FieldsIndexed User FieldsLogin Page CookiesPassword-Hashing AlgorithmsRequired Network Hostname Access
APIs
Authenticate with our APIsConfigure CORSError Codes
Identity Provider APIs
AppleEpic GamesExternal JWTFacebookGoogleHYPRLinkedInLinksNintendoOpenID ConnectSAML v2SAML v2 IdP InitiatedSony PlayStation NetworkSteamTestTwitchTwitter/XXbox
Messenger APIs
Generic MessengerTwilio Messenger
SCIM APIs
EnterpriseUserGroupService ProviderUser
Connector APIs
Generic Connector APILDAP Connector API
Custom Form APIs
Form APIForm Field API
Entity APIs
Entity APIEntity Type APIGrant API
Theme APIs
Advanced ThemesSimple Themes
API Keys API
Create an API KeyRetrieve an API KeyUpdate an API KeyDelete an API Key
Application API
Create an ApplicationRetrieve an ApplicationUpdate an ApplicationSearch for ApplicationsDelete an ApplicationReactivate an ApplicationCreate an Application RoleUpdate an Application RoleDelete an Application RoleRetrieve OAuth Configuration
Audit Log API
Search the Audit LogAdd an Entry to the Audit LogRetrieve an Audit LogExport Audit Logs
Consent API
Create a ConsentRetrieve a ConsentUpdate a ConsentDelete a ConsentSearch for ConsentsGrant a User ConsentRetrieve a User ConsentUpdate a User ConsentRevoke a User Consent
Email API
Create an Email TemplateRetrieve an Email TemplateSearch for Email TemplatesUpdate an Email TemplateDelete an Email TemplatePreview an Email TemplateSend an Email
Event Log API
Family API
Add a User to a FamilyRetrieve a FamilyUpdate a FamilyRemove a User from a FamilyRetrieve Pending Family MembersRequest Parental Approval
Group API
Create a GroupRetrieve a GroupUpdate a GroupDelete a GroupSearch for GroupsAdd Users to a GroupUpdate Users in a GroupRemove Users from a GroupSearch for Group Members
Hosted Backend APIIdentity Verify APIIntegration API
IP Access Control List API
Create an IP ACLRetrieve an IP ACLSearch for IP ACLsUpdate an IP ACLDelete an IP ACL
JWTs & Refresh Token API
Issue a JWTReconcile a JWT Using the External JWT ProviderRetrieve Public KeysRefresh a JWTRetrieve Refresh TokensRevoke Refresh TokensValidate a JWTVend a JWT
Key API
Retrieve a KeyUpdate a KeyDelete a KeySearch for KeysGenerate a KeyImport a Key
Lambda API
Create a LambdaRetrieve a LambdaSearch for LambdasUpdate a LambdaDelete a Lambda
Login API
Authenticate a UserAuthenticate a User with a One Time PasswordComplete Multi-Factor AuthenticationUpdate Login InstantLogout a UserSearch Login RecordsExport Login Records
Manage User Action API
Create a User ActionRetrieve a User ActionUpdate a User ActionDelete a User ActionReactivate a User Action
Message Template API
Multi-Factor API
Enable Multi-FactorDisable Multi-FactorUpdate Multi-Factor MethodGenerate a SecretStart Multi-FactorRetrieve Multi-Factor StatusSend a Multi-Factor Code During Login or Step UpSend a Multi-Factor Code When Enabling MFASend a Multi-Factor Code When Disabling MFAGenerate Recovery CodesRetrieve Recovery Codes
OAuth Scopes API
OAuth2 API
AuthorizeLogoutTokenDeviceIntrospectUserInfoJSON Web Key Set (JWKS)OpenID ConfigurationOAuthErrorClient Secret
Passwordless API
Start Passwordless LoginSend Passwordless LoginComplete a Passwordless Login
Reactor API
Report API
Retrieve Totals ReportRetrieve Daily Active Users ReportRetrieve Login ReportRetrieve Monthly Active Users ReportRetrieve Registration Report
System API
Retrieve the System ConfigurationUpdate the System ConfigurationExport System LogsRetrieve the Logging LevelUpdate the Logging LevelRebuild the Elasticsearch indexRetrieve the status of an index rebuildRetrieve System StatusRetrieve System HealthRetrieve System VersionRetrieve System Metrics Using Prometheus
Tenant Manager API
Tenants API
Create a TenantRetrieve a TenantSearch for TenantsUpdate a TenantDelete a TenantRetrieve the Password Validation Rules
User Action APIUser Action Reason API
User API
Create a UserRetrieve a UserUpdate a UserDelete a UserBulk Delete UsersReactivate a UserImport UsersImport Refresh TokensSearch for UsersFlush the Search EngineRetrieve Recent LoginsVerify a User's EmailResend Verification EmailStart Forgot Password WorkflowValidate a password changeChange a User's Password
User Comment API
Add a Comment to a UserRetrieve a User's CommentsSearch for User Comments
User Registration API
Create a User Registration (for an existing user)Create a User and Registration (combined)Retrieve a User RegistrationUpdate a User RegistrationDelete a User RegistrationVerify a User RegistrationResend a User Registration Verification Email
WebAuthn API
Retrieve a PasskeyDelete a PasskeyImport PasskeysStart a WebAuthn Passkey RegistrationComplete a WebAuthn Passkey RegistrationStart a WebAuthn Passkey Assertion or AuthenticationComplete a WebAuthn Passkey AuthenticationComplete a WebAuthn Passkey Assertion
Webhook API
Create a WebhookRetrieve a WebhookUpdate a WebhookDelete a WebhookSearch for Webhooks
Webhook Event Log API
Developer Tools
Base64 Encoder/DecoderEpoch/Unix Time ConverterJWT DecoderURL Encoder/DecoderUUID Generator
Release Notes
FusionAuth

Get Started

  • download locally
  • FusionAuth Cloud
  • quickstarts

product

  • features
  • pricing

developers

  • SDKs
  • API Docs
  • Documentation
  • release notes
  • trust center

resources

  • support forum
  • FusionAuth Cloud status
  • blog
  • articles
FusionAuth GithubFusionAuth TwitterFusionAuth LinkedInFusionAuth YoutubeFusionAuth Dev.to
© 2026 FusionAuth. All Rights Reserved.License •License FAQ •Privacy•Product Privacy Policy•Cookie Policy