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/
Initiate multi-factor authentication (MFA) enrollment using SMS.
This endpoint begins the SMS-based MFA setup by sending a verification code to the provided phone number.
The request must include:
phoneNumber: The user's mobile phone number in international format. It must match the format defined in your organization's phone number validation pattern (phoneNumberRegexp).Use this endpoint as the first step in enabling SMS-based MFA for a user.
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll
https://api.us.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll
https://api.ca.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll
https://api.au.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll
https://app-xxx.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll
curl -i -X POST \
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"phoneNumber": "string"
}'Complete enrollment in multi-factor authentication (MFA) using SMS.
This endpoint finalizes the SMS-based MFA setup for the user by verifying the code sent to their phone number.
The request must include:
otcToken: Token received from the initial SMS MFA enrollment step.code: The numeric code sent via SMS to the user's registered phone number.Use this endpoint to verify the user's phone number and activate SMS-based MFA on their account.
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll/verify
https://api.us.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll/verify
https://api.ca.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll/verify
https://api.au.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll/verify
https://app-xxx.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll/verify
curl -i -X POST \
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/enroll/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"otcToken": "string",
"code": "string"
}'Verify multi-factor authentication (MFA) using an SMS-based device.
This endpoint confirms the SMS MFA challenge as part of the authentication or step-up verification process for a specific registered device.
Path parameters:
deviceId: The unique identifier of the SMS MFA device being verified.Request body must include:
mfaToken: Token provided during the authentication or challenge flow.Use this endpoint to complete SMS-based MFA verification for the specified device.
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}
https://api.us.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}
https://api.ca.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}
https://api.au.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}
https://app-xxx.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}
curl -i -X POST \
'https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"mfaToken": "string"
}'