Frontegg offers a comprehensive suite of authentication, user management, and security features to streamline identity management and enhance application security. This section provides an overview of all relevant API endpoints, organized into Authentication, Management, and Self-Service categories.
Authentication Endpoints: Enable secure user login, multi-factor authentication (MFA), passwordless options, and social login integrations, allowing for a flexible and robust sign-in experience.
Management Endpoints: Require environment-level authorization and provide full control over SSO (SAML and OpenID Connect) resources, user roles, permissions, and configurations. These endpoints are designed for administrative use, allowing for centralized identity and access management.
Self-Service Endpoints: Accessible with a user token (JWT), these endpoints empower users to manage their SSO connections and other account settings. Users with the necessary permissions can create, update, or delete SSO configurations directly, ensuring they have the tools to manage their access securely and independently.
Each category in this section helps you configure and extend Frontegg’s capabilities, providing the flexibility to manage user identities, authentication protocols, and access controls as per your application’s needs.
https://api.frontegg.com/identity/
https://api.us.frontegg.com/identity/
https://api.ca.frontegg.com/identity/
https://api.au.frontegg.com/identity/
https://{domain}.frontegg.com/identity/
Recover multi-factor authentication (MFA) for a non-logged-in user.
This endpoint verifies a user's identity using a backup recovery code, typically generated by the user's MFA authenticator app during initial setup.
Use this when a user cannot access their MFA device and needs to authenticate with their recovery code.
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/recover
https://api.us.frontegg.com/identity/resources/auth/v1/user/mfa/recover
https://api.ca.frontegg.com/identity/resources/auth/v1/user/mfa/recover
https://api.au.frontegg.com/identity/resources/auth/v1/user/mfa/recover
https://app-xxx.frontegg.com/identity/resources/auth/v1/user/mfa/recover
curl -i -X POST \
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/recover \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"recoveryCode": "string",
"email": "string"
}'Disable multi-factor authentication (MFA) enrollment for a logged-in user within a specific account (tenant).
This endpoint removes MFA for a user, typically used in administrative contexts where a backend system or admin manages user security settings.
The request must include the mfaToken, which is the time-based one-time password (TOTP) generated by the user's authenticator app.
Use this endpoint to programmatically disable MFA for a specific user within an account (tenant).
https://api.frontegg.com/identity/resources/users/v1/mfa/authenticator/{deviceId}/disable/verify
https://api.us.frontegg.com/identity/resources/users/v1/mfa/authenticator/{deviceId}/disable/verify
https://api.ca.frontegg.com/identity/resources/users/v1/mfa/authenticator/{deviceId}/disable/verify
https://api.au.frontegg.com/identity/resources/users/v1/mfa/authenticator/{deviceId}/disable/verify
https://app-xxx.frontegg.com/identity/resources/users/v1/mfa/authenticator/{deviceId}/disable/verify
curl -i -X POST \
'https://api.frontegg.com/identity/resources/users/v1/mfa/authenticator/{deviceId}/disable/verify' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'frontegg-user-id: string' \
-d '{
"token": "string"
}'Initiate the process of disabling SMS-based multi-factor authentication (MFA) for a specific device.
Provide the target deviceId in the request path to mark the SMS MFA device for pre-disablement. This action prepares the device for subsequent steps required to complete the removal.
Use this route as part of the MFA management flow for disabling SMS-based MFA on a per-device basis.
https://api.frontegg.com/identity/resources/users/v1/mfa/sms/{deviceId}/disable
https://api.us.frontegg.com/identity/resources/users/v1/mfa/sms/{deviceId}/disable
https://api.ca.frontegg.com/identity/resources/users/v1/mfa/sms/{deviceId}/disable
https://api.au.frontegg.com/identity/resources/users/v1/mfa/sms/{deviceId}/disable
https://app-xxx.frontegg.com/identity/resources/users/v1/mfa/sms/{deviceId}/disable
curl -i -X POST \
'https://api.frontegg.com/identity/resources/users/v1/mfa/sms/{deviceId}/disable' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'frontegg-tenant-id: string' \
-H 'frontegg-user-id: string' \
-d '{}'