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) 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"
}'Verify a multi-factor authentication (MFA) challenge using an SMS code for a specific registered device.
This endpoint finalizes the MFA step by validating the SMS code and may mark the device as trusted if specified.
Path parameters:
deviceId: The unique identifier of the SMS MFA device being verified.Request body must include:
otcToken: Token received from the SMS MFA challenge initiation.code: The verification code sent to the user's phone via SMS.mfaToken: MFA token issued during the initial login or step-up challenge.rememberDevice (optional): Set to true to remember the device and reduce future MFA prompts on this device.Use this endpoint to complete SMS-based MFA verification and optionally trust the device for future logins.
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}/verify
https://api.us.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}/verify
https://api.ca.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}/verify
https://api.au.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}/verify
https://app-xxx.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}/verify
curl -i -X POST \
'https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}/verify' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"otcToken": "string",
"code": "string",
"mfaToken": "string",
"rememberDevice": true
}'Initiate multi-factor authentication (MFA) enrollment using WebAuthn (e.g., security keys, biometrics).
This endpoint begins the WebAuthn MFA setup by returning a browser-based challenge needed to link a trusted device, such as a biometric reader or hardware security key.
The request must include:
mfaToken: Token issued during the authentication flow to authorize MFA setup.Use this endpoint as the first step when enrolling a user in WebAuthn-based MFA.
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll
https://api.us.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll
https://api.ca.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll
https://api.au.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll
https://app-xxx.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll
curl -i -X POST \
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"mfaToken": "string"
}'