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 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"
}'Complete enrollment in multi-factor authentication (MFA) using WebAuthn.
This endpoint verifies and registers a WebAuthn device, such as a biometric sensor (Platform) or hardware security key (CrossPlatform), finalizing the setup after the initial challenge.
The request must include:
deviceType: Type of device being enrolled. Accepts Platform (e.g., fingerprint scanner) or CrossPlatform (e.g., USB security key).webauthnToken: Token received during the WebAuthn pre-enrollment step.options: WebAuthn attestation data collected from the client.id: Device identifier.response: WebAuthn attestation response.clientDataJSON: Base64-encoded client data from the browser.attestationObject: Base64-encoded attestation object from the authenticator.deviceType (optional): May repeat the selected device type.mfaToken: Token used to authorize MFA enrollment.rememberDevice (optional): Set to true to remember the device and reduce MFA prompts on future logins.Use this endpoint to complete WebAuthn-based MFA enrollment and register the user's trusted device.
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll/verify
https://api.us.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll/verify
https://api.ca.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll/verify
https://api.au.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll/verify
https://app-xxx.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll/verify
curl -i -X POST \
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/enroll/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"deviceType": "Platform",
"webauthnToken": "string",
"options": {
"id": "string",
"response": {
"clientDataJSON": "string",
"attestationObject": "string"
},
"deviceType": "Platform"
},
"mfaToken": "string",
"rememberDevice": true
}'Verify a multi-factor authentication (MFA) challenge using a registered WebAuthn device.
This endpoint completes WebAuthn-based MFA verification, typically following primary authentication when WebAuthn is required as a second factor.
Path parameters:
deviceId: The unique identifier of the WebAuthn device to be verified.Request body must include:
mfaToken: Token issued during the login or step-up authentication flow.Use this endpoint to validate a WebAuthn device and complete the MFA step during authentication.
https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/{deviceId}
https://api.us.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/{deviceId}
https://api.ca.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/{deviceId}
https://api.au.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/{deviceId}
https://app-xxx.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/{deviceId}
curl -i -X POST \
'https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/{deviceId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"mfaToken": "string"
}'