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/
Verify multi-factor authentication (MFA) enrollment using a QR code for a specific user within an account (tenant).
This endpoint completes MFA enrollment after the user scans a QR code with an authenticator app (e.g., Google Authenticator, Authy).
Request body must include:
mfaToken: The time-based one-time password (TOTP) generated by the authenticator app after scanning the QR code.Use this endpoint to confirm that the user has successfully registered their authenticator app and to activate MFA for their account.
https://api.frontegg.com/identity/resources/users/v1/mfa/authenticator/enroll/verify
https://api.us.frontegg.com/identity/resources/users/v1/mfa/authenticator/enroll/verify
https://api.ca.frontegg.com/identity/resources/users/v1/mfa/authenticator/enroll/verify
https://api.au.frontegg.com/identity/resources/users/v1/mfa/authenticator/enroll/verify
https://app-xxx.frontegg.com/identity/resources/users/v1/mfa/authenticator/enroll/verify
curl -i -X POST \
https://api.frontegg.com/identity/resources/users/v1/mfa/authenticator/enroll/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'frontegg-user-id: string' \
-d '{
"token": "string"
}'{ "recoveryCode": "string" }
Enroll a user in SMS-based multi-factor authentication (MFA).
This endpoint initiates SMS MFA enrollment by sending a verification code to the user's phone number.
Request body must include:
phoneNumber: The user's mobile number in international format. Must match the validation pattern defined by phoneNumberRegexp.Use this endpoint to begin the SMS MFA setup process for a specific user. The next step is to verify the SMS code to complete enrollment.
https://api.frontegg.com/identity/resources/users/v1/mfa/sms/enroll
https://api.us.frontegg.com/identity/resources/users/v1/mfa/sms/enroll
https://api.ca.frontegg.com/identity/resources/users/v1/mfa/sms/enroll
https://api.au.frontegg.com/identity/resources/users/v1/mfa/sms/enroll
https://app-xxx.frontegg.com/identity/resources/users/v1/mfa/sms/enroll
curl -i -X POST \
https://api.frontegg.com/identity/resources/users/v1/mfa/sms/enroll \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'frontegg-user-id: string' \
-d '{
"phoneNumber": "string"
}'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"
}'