Resources

Docs
Articles
Blog
Release Notes
Install

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/get-started/quickstarts/api.md.

API

Edit on GitHubEdit MD

Edit on GitHubEdit

.NET API

.NET API

Golang API

Golang API

Laravel API

Laravel API

Node/Express API

Node/Express API

Ruby on Rails API

Ruby on Rails API

Spring Boot API

Spring Boot API

Step 1 - Install FusionAuthStep 2 - Login ButtonStep 3 - Protected PagesStep 4 - Role-Based Access ControlStep 5 - Session ManagementStep 6 - LogoutStep 7 - TestingStep 8 - Finished

Docker First Time Setup Upgrade fusionauth-appInstall a Database Install a Search Engine Start & Stop

Access from the InternetAPI MCP ServerDocs MCP ServerKickstart

Deploy with k8sElastic Kubernetes Service (EKS)Google Kubernetes Engine (GKE)Local Cluster with minikubeMicrosoft Azure Kubernetes Service (AKS)

Install Reference

Air-gappingCollected MetricsFusionAuth Account PortalPackagesServer LayoutSilent ModeSystem Requirements

Express.NETDrupalGolangLaravelNext.jsNuxtPHPPython DjangoPython FlaskRemixRuby on RailsRust with ActixSpring Boot With ThymeleafWordPress

Single-page App

ReactAngularVue.js

Android Java - AppAuthAndroid Kotlin - Fusionauth SDKFlutteriOS Swift - AppAuthiOS Swift - FusionAuth SDKReact Native

.NET APIGolang APILaravel APINode.js/Express.js APIRuby on Rails APISpring Boot API

ApplicationsOAuth ScopesTenantsUsersEntity ManagementGroupsRegistrationsRolesTypesAuthentication and AuthorizationIdentity ProvidersIntegration PointsLocalization and InternationalizationLogin Pages - Hosted or APILicensingLimitationsPlans and FeaturesPremium Features

Run in the Cloud

Disaster Recovery FusionAuth Cloud GitHub Actions

AWSDigitalOceanGitHub ActionsGoogle CloudRender

Auth as a ServiceApp SuiteBusiness To Business To ConsumerBusiness To Business To EmployeeMachine To Machine CommunicationIdentity BrokerAuthorization HubAPI Consents Platform

Customize Advanced Themes

Upgrade an Advanced ThemeAdvanced Theme Upgrade NotesTheme ExamplesAdd a Theme to a KickstartTailwind CSSTheme Template VariablesThemes Helper Macros

Simple Theme Editor Application-Specific Themes Client-side Password Rule Validation Theme Localization

Email & Messages

Application Email TemplatesGeneric MessengerMessengersSend Messages with TwilioConfigure SMTPEmail TemplatesEmail VariablesMessage TemplatesMessage VariablesPre-1.26 2FATwilio IntegrationTwo-Factor with Google AuthenticatorTwo-Factor with Twilio Push Notifications

FusionAuth and ProxiesFusionAuth And TerraformFusionAuth Cluster SetupUpgrade FusionAuthUser Support Guide

CloudWatchDatadogElasticOpenTelemetryPrometheus, Loki, And GrafanaSlackSplunk

Deprecation Policy Releases

Advanced Threat DetectionBreached Password DetectionCompliance FrameworksCORS ReferenceKey MasterKey RotationNetworking ConfigurationToken Storage

Troubleshooting

Technical Support

Events & Webhooks

EventsAudit Log CreateEvent Log CreateJWTPublic Key UpdateRefreshRefresh Token Revoke
Kickstart SuccessGroupCreateCreate CompleteDeleteDelete CompleteMember AddMember Add CompleteMember RemoveMember Remove CompleteMember UpdateMember Update CompleteUpdateUpdate Complete
UserActionBulk CreateCreateCreate CompleteDeactivateDeleteDelete CompleteEmail UpdateEmail VerifiedIdentity Provider LinkIdentity Provider UnlinkIdentity VerifiedReactivateTwo Factor ChallengeTwo Factor Failed AttemptTwo Factor SuccessTwo-factor Method AddTwo-factor Method RemoveUpdateUpdate CompleteLoginFailedId Duplicate CreateId Duplicate UpdateNew DeviceSuccessSuspicious
PasswordBreachReset SendReset StartReset SuccessUpdate
RegistrationCreateCreate CompleteDeleteDelete CompleteUpdateUpdate CompleteVerified
Kafka IntegrationSecure WebhooksSign WebhooksWebhook Event LogWrite a Webhook

Fine-Grained Authorization

Code

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 LambdaReconcileApple 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

Custom Password Hashing Writing a Plugin

Examples

Docker InstallFast Path InstallSandbox

Amazon API GatewayCloudflare Worker Functions (API Gateway)HAProxy API GatewayKong Gatewayngrok Cloud EdgeSecuring your APIs with FusionAuth

Control MCP Server Access Device Limiting Example Applications Modeling Hierarchies Modeling Organizations Multi-Application Dashboard Multi-tenancy Twilio Segment

FusionAuth ConnectorGeneric ConnectorLDAP Connector

Export from FusionAuth Generic Migration Tutorial

Azure AD SCIM ClientOkta SCIM ClientSCIM-SDK

Framework Specific

Migrate From Passport Migrate 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

Advanced Registration FormsAnonymous UsersComplete RegistrationRegister A User And LoginSelf-service Registration

Authenticate Users

Add an Identity Provider (IdP)

Add an OpenID Connect IdP Add 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

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 Tokens Contextual Multi-Factor Authentication (MFA)Host a SAML v2 Identity Provider Implementing Single Sign-on Logout And Session Management Multi-Factor Authentication (MFA)Setting Up User Account Lockout

Integrations

OpenID Connect Integrations

OIDC & CockroachDBOIDC & SalesforceOIDC & Tableau Cloud

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 App CleanSpeak Integration Custom Admin Forms How To Use User Actions

Searching Users With Elasticsearch or OpenSearch Switching 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

API Endpoints Guarded by API KeysAuthentication TypesConfiguration ReferenceData TypesGDPR ComplianceIndexed Entity FieldsIndexed User FieldsLogin Page CookiesPassword-Hashing AlgorithmsRequired Network Hostname Access

Authenticate with our APIs Configure CORS Error Codes

Identity Provider APIs

AppleEpic GamesExternal JWTFacebookGoogleHYPRLinkedInLinksNintendoOpenID ConnectSAML v2SAML v2 IdP InitiatedSony PlayStation NetworkSteamTestTwitchTwitter/XXbox

Generic Messenger Twilio Messenger

EnterpriseUserGroupService ProviderUser

Generic Connector API LDAP Connector API

Custom Form APIs

Form API Form Field API

Entity APIEntity Type APIGrant API

Advanced Themes Simple Themes

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

Search the Audit LogAdd an Entry to the Audit LogRetrieve an Audit LogExport Audit Logs

Create a ConsentRetrieve a ConsentUpdate a ConsentDelete a ConsentSearch for ConsentsGrant a User ConsentRetrieve a User ConsentUpdate a User ConsentRevoke a User Consent

Create an Email TemplateRetrieve an Email TemplateSearch for Email TemplatesUpdate an Email TemplateDelete an Email TemplatePreview an Email TemplateSend an Email

Add a User to a FamilyRetrieve a FamilyUpdate a FamilyRemove a User from a FamilyRetrieve Pending Family MembersRequest Parental Approval

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 API Identity Verify API Integration 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

Retrieve a KeyUpdate a KeyDelete a KeySearch for KeysGenerate a KeyImport a Key

Create a LambdaRetrieve a LambdaSearch for LambdasUpdate a LambdaDelete a Lambda

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

AuthorizeLogoutTokenDeviceIntrospectUserInfoJSON Web Key Set (JWKS)OpenID ConfigurationOAuthErrorClient Secret

Passwordless API

Start Passwordless LoginSend Passwordless LoginComplete a Passwordless Login

Retrieve Totals ReportRetrieve Daily Active Users ReportRetrieve Login ReportRetrieve Monthly Active Users ReportRetrieve Registration Report

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

Create a TenantRetrieve a TenantSearch for TenantsUpdate a TenantDelete a TenantRetrieve the Password Validation Rules

User Action API User Action Reason 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

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

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

On this page