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/
https://api.frontegg.com/identity/resources/users/v1/email/me
https://api.us.frontegg.com/identity/resources/users/v1/email/me
https://api.ca.frontegg.com/identity/resources/users/v1/email/me
https://api.au.frontegg.com/identity/resources/users/v1/email/me
https://app-xxx.frontegg.com/identity/resources/users/v1/email/me
curl -i -X POST \
https://api.frontegg.com/identity/resources/users/v1/email/me \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"email": "string"
}'https://api.frontegg.com/identity/resources/users/v1/email/me/verify
https://api.us.frontegg.com/identity/resources/users/v1/email/me/verify
https://api.ca.frontegg.com/identity/resources/users/v1/email/me/verify
https://api.au.frontegg.com/identity/resources/users/v1/email/me/verify
https://app-xxx.frontegg.com/identity/resources/users/v1/email/me/verify
curl -i -X POST \
https://api.frontegg.com/identity/resources/users/v1/email/me/verify \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"code": "string",
"email": "string"
}'This route activates a non-activated user. You can use it to create your own activation flow. Send the frontegg-vendor-host as a header to declare which vendor. This is your domain name in the Frontegg Portal. Send the required userId and activation token in the POST body. For generating an activation token, see the route under users for generating an activation token. If the vendor's sign in flow requires a password or recaptcha, send those values in the POST body. Instead of this route, consider using our email template for user activation.
https://api.frontegg.com/identity/resources/users/v1/activate
https://api.us.frontegg.com/identity/resources/users/v1/activate
https://api.ca.frontegg.com/identity/resources/users/v1/activate
https://api.au.frontegg.com/identity/resources/users/v1/activate
https://app-xxx.frontegg.com/identity/resources/users/v1/activate
curl -i -X POST \
https://api.frontegg.com/identity/resources/users/v1/activate \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-H 'frontegg-vendor-host: string' \
-d '{
"userId": "string",
"token": "string",
"password": "string",
"recaptchaToken": "string",
"lastTermsCheck": "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 }