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/
Activate a non-activated user.
Include the userId and activationToken in the request body. If required by your environment's sign-in flow, also include the user's password and reCAPTCHA values.
You can generate an activation token using the route under Users → Generate Activation Token.
Alternatively, you can use the built-in 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 }
Activate a non-activated user.
Use this endpoint to implement a custom activation flow.
Include the userId, activationToken, and code in the request body. If required by your environment's sign-in flow, also include the user's password and reCAPTCHA values.
You can generate an activation token using the route under Users → Generate Activation Token.
Alternatively, you can use the built-in email template for user activation.
https://api.frontegg.com/identity/resources/users/v1/activate/code
https://api.us.frontegg.com/identity/resources/users/v1/activate/code
https://api.ca.frontegg.com/identity/resources/users/v1/activate/code
https://api.au.frontegg.com/identity/resources/users/v1/activate/code
https://app-xxx.frontegg.com/identity/resources/users/v1/activate/code
curl -i -X POST \
https://api.frontegg.com/identity/resources/users/v1/activate/code \
-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",
"code": "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 }
Retrieve a user's activation strategy.
The activation strategy indicates whether the user needs to set a password.
Include the userId and activationToken in the request body. You can generate an activation token using the route under Users → Generate Activation Token.
The response returns a Boolean field shouldSetPassword. If true, the user needs to set a password. If false, the user does not need to set a password (for example, SSO users do not set passwords).
https://api.frontegg.com/identity/resources/users/v1/activate/strategy
https://api.us.frontegg.com/identity/resources/users/v1/activate/strategy
https://api.ca.frontegg.com/identity/resources/users/v1/activate/strategy
https://api.au.frontegg.com/identity/resources/users/v1/activate/strategy
https://app-xxx.frontegg.com/identity/resources/users/v1/activate/strategy
curl -i -X GET \
'https://api.frontegg.com/identity/resources/users/v1/activate/strategy?token=string&userId=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "shouldSetPassword": true }