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 passwordless authentication by sending a magic link to the user's email address.
This is the first step in the magic link passwordless login flow for local users. The system sends an email containing a secure login link to the provided address.
Request body must include:
email: The email address of the user initiating the login.invitationToken (optional): Include if the user is signing up through an invitation.recaptchaToken (optional): Required if reCAPTCHA is enabled for login.Use this endpoint to start the magic link authentication process by delivering a login link to the user's email inbox.
https://api.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/prelogin
https://api.us.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/prelogin
https://api.ca.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/prelogin
https://api.au.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/prelogin
https://app-xxx.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/prelogin
curl -i -X POST \
https://api.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/prelogin \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"recaptchaToken": "string",
"invitationToken": "string",
"email": "string",
"userId": "string",
"username": "string"
}'Complete passwordless authentication using a magic link.
This is the second step in the magic link passwordless login flow for local users. After the user clicks the link in their email, this endpoint validates the token and authenticates the user.
Request body must include:
token: The token ID extracted from the magic link.invitationToken (optional): Include if the user is signing up through an invitation.recaptchaToken (optional): Required if reCAPTCHA is enabled for login.Use this endpoint to complete the magic link login flow and receive authentication credentials, including a JWT and a refresh cookie.
https://api.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/postlogin
https://api.us.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/postlogin
https://api.ca.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/postlogin
https://api.au.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/postlogin
https://app-xxx.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/postlogin
curl -i -X POST \
https://api.frontegg.com/identity/resources/auth/v1/passwordless/magiclink/postlogin \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"token": "string",
"recaptchaToken": "string",
"invitationToken": "string"
}'{ "tokenType": "bearer", "otcToken": "string", "mfaRequired": true, "mfaToken": "string", "resetPasswordToken": "string", "passwordExpiresIn": 0, "notificationPeriod": 0, "mfaEnrolled": true, "mfaDevices": { "webauthn": [ … ], "phones": [ … ], "authenticators": [ … ], "emails": [ … ] }, "mfaStrategies": {}, "qrCode": "string", "recoveryCode": "string", "accessToken": "string", "refreshToken": "string", "expiresIn": 0, "expires": "string", "userId": "string", "userEmail": "string", "emailVerified": true, "isBreachedPassword": true }
Initiate passwordless authentication by sending a one-time code (OTC) to the user's email address.
This is the first step in the email OTC (one-time code) passwordless login flow for local users. The system sends a time-sensitive code to the specified email address.
Request body must include:
email: The email address of the user initiating the login.invitationToken (optional): Include if the user is signing up through an invitation.recaptchaToken (optional): Required if reCAPTCHA is enabled for login.Use this endpoint to start the passwordless login process via an email-based one-time code.
https://api.frontegg.com/identity/resources/auth/v1/passwordless/code/prelogin
https://api.us.frontegg.com/identity/resources/auth/v1/passwordless/code/prelogin
https://api.ca.frontegg.com/identity/resources/auth/v1/passwordless/code/prelogin
https://api.au.frontegg.com/identity/resources/auth/v1/passwordless/code/prelogin
https://app-xxx.frontegg.com/identity/resources/auth/v1/passwordless/code/prelogin
curl -i -X POST \
https://api.frontegg.com/identity/resources/auth/v1/passwordless/code/prelogin \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"recaptchaToken": "string",
"invitationToken": "string",
"email": "string",
"userId": "string",
"username": "string"
}'