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/
Complete SMS-based multi-factor authentication (MFA) enrollment for a user.
This endpoint finalizes SMS MFA setup by verifying the code sent to the user's phone.
Request body must include:
otcToken: One-time challenge token received from the initial enrollment step.code: The verification code sent to the user's phone via SMS.Use this endpoint to verify the user's phone number and activate SMS-based MFA for their account.
https://api.frontegg.com/identity/resources/users/v1/mfa/sms/enroll/verify
https://api.us.frontegg.com/identity/resources/users/v1/mfa/sms/enroll/verify
https://api.ca.frontegg.com/identity/resources/users/v1/mfa/sms/enroll/verify
https://api.au.frontegg.com/identity/resources/users/v1/mfa/sms/enroll/verify
https://app-xxx.frontegg.com/identity/resources/users/v1/mfa/sms/enroll/verify
curl -i -X POST \
https://api.frontegg.com/identity/resources/users/v1/mfa/sms/enroll/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'frontegg-user-id: string' \
-d '{
"otcToken": "string",
"code": "string"
}'Disable MFA enrollment for a logged-in user within a specific account (tenant).
This endpoint disables multi-factor authentication for a user, using the mfaToken obtained from the user's authenticator app.
Use this endpoint to programmatically disable MFA when managing authentication settings at the account (tenant) level.
https://api.frontegg.com/identity/resources/users/v1/mfa/disable
https://api.us.frontegg.com/identity/resources/users/v1/mfa/disable
https://api.ca.frontegg.com/identity/resources/users/v1/mfa/disable
https://api.au.frontegg.com/identity/resources/users/v1/mfa/disable
https://app-xxx.frontegg.com/identity/resources/users/v1/mfa/disable
curl -i -X POST \
https://api.frontegg.com/identity/resources/users/v1/mfa/disable \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'frontegg-user-id: string' \
-d '{
"token": "string"
}'Verify a multi-factor authentication (MFA) code generated by an authenticator app during the authentication process.
This endpoint completes the MFA step by validating the provided code.
The request must include:
value: The MFA service name (e.g., authenticator), as configured in your Authentication Settings.mfaToken: The time-based one-time password (TOTP) generated by the user's authenticator app.Use this endpoint to verify the user's MFA code during an authentication challenge, typically after the primary login step.
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/verify
https://api.us.frontegg.com/identity/resources/auth/v1/user/mfa/verify
https://api.ca.frontegg.com/identity/resources/auth/v1/user/mfa/verify
https://api.au.frontegg.com/identity/resources/auth/v1/user/mfa/verify
https://app-xxx.frontegg.com/identity/resources/auth/v1/user/mfa/verify
curl -i -X POST \
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"value": "string",
"mfaToken": "string",
"rememberDevice": true
}'