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

API

EditMD
Edit on GitHubView Markdown
On this page

.NET API

QuickStart integration of .NET Web API with FusionAuth.

Golang API

QuickStart integration of a Golang API application using FusionAuth as a resource server.

Laravel API

QuickStart integration of a Laravel API application using FusionAuth.

Node.js/Express.js API

QuickStart integration of a JavaScript Express.js API application action as a resource server with FusionAuth.

Ruby on Rails API

QuickStart Integration of a Ruby on Rails API with FusionAuth.

Spring Boot API

QuickStart integration of a Spring Boot API application action as a resource server with FusionAuth.

Related

APIs

Authenticate with our APIs

Learn how the FusionAuth APIs authenticate requests.

api authenticationfusionauth apirest api
APIs

Hosted Backend API

Learn about the APIs that you to perform OAuth2 Authorization Code Flow login, logout, and refresh for applications.

fusionauth apirest apibackend api
APIs

User Action API

Learn about the APIs for invoking a User Action on a User.

fusionauth apirest api
APIs

Create an API Key API

API documentation for the FusionAuth Create an API Key API.

fusionauth apirest api

On this page

Get Started
OverviewInstall LocallyFirst Time SetupWhat to Do Next
Develop
OverviewAccess from the InternetAPI MCP ServerDocs MCP ServerExample ApplicationsKickstart
QuickStarts
Overview
Web
OverviewExpress.NETDrupalGolangLaravelNext.jsNuxtPHPPython DjangoPython FlaskRemixRuby on RailsRust with ActixSpring Boot With ThymeleafWordPress
Single-page App
OverviewReactAngularVue.js
App
OverviewAndroid Java - AppAuthAndroid Kotlin - Fusionauth SDKFlutteriOS Swift - AppAuthiOS Swift - FusionAuth SDKReact Native
API
Overview.NET APIGolang APILaravel APINode.js/Express.js APIRuby on Rails APISpring Boot API
How FusionAuth Works
Overview
Core Types
OverviewTenantsApplicationsUsersRegistrationsRolesGroupsEntity ManagementCIMD DomainsIndexed Entity Fields
Authentication and AuthorizationIdentity ProvidersIntegration PointsLocalization and InternationalizationOAuth Scopes
Patterns
OverviewAuth as a ServiceApp SuiteBusiness To Business To ConsumerBusiness To Business To EmployeeMachine To Machine CommunicationIdentity BrokerAuthorization HubAPI Consents PlatformModeling HierarchiesModeling OrganizationsMulti-tenancy
Plans and Limits
OverviewPlans and FeaturesLicensingLimitationsCollected Metrics
Authentication
Overview
OAuth
OverviewCIMD Registration Caching And LifecycleConnect Claude And ChatGPT To An MCP ServerHost A Client ID Metadata DocumentManage Software TokensModesOAuth Client RegistrationOAuth DPoPOAuth Issuer ValidationOAuth Response ModesOIDC PromptURL Validation
Add an Identity Provider (IdP)
OverviewAdd an OpenID Connect IdPAdd an External SAML v2 IdP
Add an External JWT IdP
OverviewExternal 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
Passkeys
OverviewConfigureCustomize
One-Time Passwords
OverviewConfigureCustomize
Multi-Factor Authentication (MFA)
OverviewContextual Multi-Factor Authentication (MFA)
Sessions and SSO
Implementing Single Sign-onLogout And Session ManagementDevice LimitingMulti-Application Dashboard
Build a Login Page with the Login API
OverviewJSON Web Tokens
Act as an Identity Provider
Host a SAML v2 Identity Provider
OpenID Connect Integrations
OverviewOIDC & CockroachDBOIDC & SalesforceOIDC & Tableau Cloud
SAML v2 Integrations
OverviewSAML v2 & AivenSAML v2 & GoogleSAML v2 & PagerDutySAML v2 & SendGridSAML v2 & Tableau CloudSAML v2 & Zendesk
Application Authentication TokensAuthentication TypesLogin Page Cookies
Users
Overview
Register
OverviewAdvanced Registration FormsAnonymous UsersComplete RegistrationRegister A User And LoginSelf-service Registration
Verify
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
Self-Service Account Management
OverviewAccount 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
Search
OverviewIndexed User FieldsSearching Users With Elasticsearch or OpenSearchSwitching Search Engines
Provision and Connect
Connectors
OverviewFusionAuth ConnectorGeneric ConnectorLDAP Connector
SCIM
OverviewAzure AD SCIM ClientOkta SCIM ClientSCIM-SDK
Tenant Manager AppCleanSpeak IntegrationCustom Admin FormsHow To Use User ActionsUser Support Guide
Authorization
OverviewAccess Control with OAuth ScopesFine-Grained AuthorizationOAuth Token ExchangeDelegate Access With Token Exchange
API Gateways
OverviewAmazon API GatewayCloudflare Worker Functions (API Gateway)HAProxy API GatewayKong Gatewayngrok Cloud EdgeSecuring your APIs with FusionAuth
Control MCP Server Access
Theme
OverviewSimple ThemesApplication-Specific ThemesTheme Localization
Advanced Themes
OverviewUpdate an Advanced ThemeTheme ExamplesUpdate GuidesAdd a Theme to a KickstartClient-side Password Rule ValidationTailwind CSSTheme Template VariablesThemes Helper Macros
Email
OverviewConfigure SMTPApplication-Specific Email TemplatesCreate an Email TemplateTemplate Reference
Messengers
OverviewConfigure a Custom MessengerConfigure a Twilio MessengerCreate a Message TemplateTemplate Reference
Lambdas
Overview
Tokens and Responses
Client Credentials JWT Populate LambdaJWT Populate LambdaSAML v2 Populate LambdaUserInfo Populate Lambda
Login and Registration
CIMD Client Registration LambdaLogin Validation LambdaMFA Requirement LambdaSelf-Service Registration Validation 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
SCIM
SCIM Group Request Converter LambdaSCIM Group Response Converter LambdaSCIM User Request Converter LambdaSCIM User Response Converter Lambda
Token Exchange
Token Exchange Policy LambdaToken Exchange Populate Lambda
Call an API from a LambdaTest Lambdas
Events
Overview
Webhooks
Write a WebhookSecure WebhooksSign WebhooksWebhook Event Log
Kafka Integration
Reference
OverviewAudit Log CreateEvent Log CreateKickstart Success
CIMD
Registration FailedRegistration Success
Entity
CreateCreate CompleteDeleteDelete CompleteUpdateUpdate Complete
Group
CreateCreate CompleteDeleteDelete CompleteMember AddMember Add CompleteMember RemoveMember Remove CompleteMember UpdateMember Update CompleteUpdateUpdate Complete
JWT
Public Key UpdateRefreshRefresh Token Revoke
Token
ExchangeExchange Complete
User
ActionBulk CreateCreateCreate CompleteDeactivateDeleteDelete CompleteEmail UpdateEmail VerifiedIdentity Provider LinkIdentity Provider UnlinkIdentity VerifiedReactivateTwo-factor ChallengeTwo-factor Failed AttemptTwo-factor Method AddTwo-factor Method RemoveTwo-Factor SuccessUpdateUpdate Complete
Login
FailedId Duplicate CreateId Duplicate UpdateNew DeviceSuccessSuspicious
Password
BreachReset SendReset StartReset SuccessUpdate
Registration
CreateCreate CompleteDeleteDelete CompleteUpdateUpdate CompleteVerified
Twilio Segment
Security
Overview
Account Protection
Account EnumerationAccount LockoutAdvanced Threat DetectionBreached Password DetectionRisk Signals
Tokens and Keys
Key MasterKey RotationToken Storage
Clients
CIMD SecurityCORS Reference
Compliance
OverviewGDPR Compliance
Deploy
Overview
Test
OverviewTest Against FusionAuthTest and Deploy with GitHub ActionsGitHub Actions
Production
System RequirementsServer Layout
Install
Install FusionAuth AppInstall a DatabaseInstall a Search EngineAir-gappingCustomize Docker ImagesPackagesSilent Mode
Kubernetes
OverviewDeploy with k8sElastic Kubernetes Service (EKS)Google Kubernetes Engine (GKE)Local Cluster with minikubeMicrosoft Azure Kubernetes Service (AKS)
Install from a Marketplace
OverviewAWSDigitalOceanGoogle CloudRender
ClusterProxyConfiguration ReferenceStart and Stop a Production InstanceTerraformFusionAuth CLI
Harden
OverviewHarden a Production InstanceNetworking ConfigurationRequired Network Hostname Access
Monitor
OverviewCloudWatchDatadogElasticOpenTelemetryPrometheus, Loki, And GrafanaSlackSplunk
Troubleshoot
TroubleshootingTechnical Support
Update
OverviewUpdate a Development InstanceUpdate a Production InstanceDatabase MigrationsRoll Back an UpdateEarly Access ProgramRoadmapDeprecation Policy
Update Guides
1.69.0 Key Configuration
Cloud
Overview
Account
OverviewCreateDelete
Create a DeploymentUpdate a DeploymentDelete a Deployment
Operate
Custom DomainsAlter a DeploymentProxyLoad TestSecurity
Cloud vs Self-Hosted
Reference
FusionAuth Cloud LimitsRegionsInstance IP AddressesSLADisaster RecoveryUser Data
Support
Migrate
OverviewGeneric Migration Tutorial
From Another Provider
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
From a Framework
Migrate From PassportMigrate From Rails
Password Hashing Plugins
OverviewCustom Password HashingPassword-Hashing AlgorithmsWriting a Plugin
Between Cloud and Self-Hosted
Migrate to FusionAuth CloudMigrate from FusionAuth Cloud
Export from FusionAuth
Client Libraries and SDKs
Overview
Example Apps
Overview.NET Core Example AppsGo Example AppsJava Example AppsPHP Example AppsPython Example AppsRuby Example AppsTypescript, Node and JavaScript Example Apps
React 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
APIs
OverviewOpenAPI SpecificationAuthenticate with our APIsConfigure CORSError Responses
Identity Provider
OverviewAppleEpic GamesExternal JWTFacebookGoogleHYPRLinkedInLinksNintendoOpenID ConnectSAML v2SAML v2 IdP InitiatedSony PlayStation NetworkSteamTestTwitchTwitter/XXbox
Messenger
OverviewGeneric MessengerTwilio Messenger
SCIM
OverviewEnterpriseUserGroupService ProviderUser
Connector
OverviewGeneric ConnectorLDAP Connector
Custom Form
FormForm Field
Entity
OverviewEntityEntity TypeGrant
Theme
Advanced ThemesSimple Themes
API Endpoints Guarded by API Keys
API Keys
OverviewCreate an API KeyRetrieve an API KeyUpdate an API KeyDelete an API Key
Application
OverviewCreate 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
OverviewSearch the Audit LogAdd an Entry to the Audit LogRetrieve an Audit LogExport Audit Logs
CIMD Client Registration
OverviewRetrieve a CIMD Client RegistrationSearch for CIMD Client RegistrationsDelete a CIMD Client Registration
CIMD Domain
OverviewCreate a CIMD DomainRetrieve a CIMD DomainUpdate a CIMD DomainSearch for CIMD DomainsDelete a CIMD Domain
CIMD Domain OAuth Scopes
Consent
OverviewCreate a ConsentRetrieve a ConsentUpdate a ConsentDelete a ConsentSearch for ConsentsGrant a User ConsentRetrieve a User ConsentUpdate a User ConsentRevoke a User Consent
Data Types
Email
OverviewCreate an Email TemplateRetrieve an Email TemplateSearch for Email TemplatesUpdate an Email TemplateDelete an Email TemplatePreview an Email TemplateSend an Email
Event Log
Family
OverviewAdd a User to a FamilyRetrieve a FamilyUpdate a FamilyRemove a User from a FamilyRetrieve Pending Family MembersRequest Parental Approval
Group
OverviewCreate 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 BackendIdentity VerifyIntegration
IP Access Control List
OverviewCreate an IP ACLRetrieve an IP ACLSearch for IP ACLsUpdate an IP ACLDelete an IP ACL
JWTs & Refresh Token
OverviewIssue a JWTReconcile a JWT Using the External JWT ProviderRetrieve Public KeysRefresh a JWTRetrieve Refresh TokensRevoke Refresh TokensValidate a JWTVend a JWT
Key
OverviewRetrieve a KeyUpdate a KeyDelete a KeySearch for KeysGenerate a KeyImport a Key
Lambda
OverviewCreate a LambdaRetrieve a LambdaSearch for LambdasUpdate a LambdaDelete a Lambda
Login
OverviewAuthenticate a UserAuthenticate a User with a One Time PasswordComplete Multi-Factor AuthenticationUpdate Login InstantLogout a UserSearch Login RecordsExport Login Records
Manage User Action
OverviewCreate a User ActionRetrieve a User ActionUpdate a User ActionDelete a User ActionReactivate a User Action
Message Template
Multi-Factor
OverviewEnable 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
OAuth2
OverviewAuthorizeLogoutTokenDeviceIntrospectUserInfoJSON Web Key Set (JWKS)OpenID ConfigurationOAuth Error ReferenceClient Secret Reference
Passwordless
OverviewStart Passwordless LoginSend Passwordless LoginComplete a Passwordless Login
Reactor
Report
OverviewRetrieve Totals ReportRetrieve Daily Active Users ReportRetrieve Login ReportRetrieve Monthly Active Users ReportRetrieve Registration Report
System
OverviewRetrieve 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 a Token Exchange ChainRetrieve System VersionSearch the Token Exchange Audit LogRetrieve System Metrics Using Prometheus
Tenant Manager
Tenants
OverviewCreate a TenantRetrieve a TenantSearch for TenantsUpdate a TenantDelete a TenantRetrieve the Password Validation Rules
User
OverviewCreate 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 ActionUser Action Reason
User Comment
OverviewAdd a Comment to a UserRetrieve a User's CommentsSearch for User Comments
User Registration
OverviewCreate 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
OverviewRetrieve 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
OverviewCreate a WebhookRetrieve a WebhookUpdate a WebhookDelete a WebhookSearch for Webhooks
Webhook Event Log
Developer Tools
OverviewBase64 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