Users, auth and security module
/
MFA
/
Verify MFA using email code

Authentication and Identity Management

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.

Download OpenAPI description
Users, Auth and Security
Single Sign-On
SCIM Provisioning
Entitlements
Entitlements Agent
Accounts (Tenants)
Languages
Servers
EU Region
https://api.frontegg.com/identity/
US Region
https://api.us.frontegg.com/identity/
CA Region
https://api.ca.frontegg.com/identity/
AU Region
https://api.au.frontegg.com/identity/
Frontegg sub-domain for use with user tokens
https://{domain}.frontegg.com/identity/

API token

Operations

General

Operations

MFA

Operations

Request verify MFA using email code

Request

Verify multi-factor authentication (MFA) using a code sent to the user's email.

This endpoint completes the email-based MFA verification step.

The request must include:

  • mfaToken: The token provided after the user initiates MFA via email.

Use this endpoint to confirm the email-based MFA challenge and finalize the login or authentication process.

Bodyapplication/jsonrequired
mfaTokenstringrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/auth/v1/user/mfa/emailcode \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "mfaToken": "string"
  }'

Responses

Verify MFA using email code

Request

Verify a multi-factor authentication (MFA) challenge using a code sent to the user's email address.

This endpoint finalizes the email-based MFA verification and completes the authentication process.

The request must include:

  • otcToken: One-time challenge token received during the email MFA initiation.
  • code: The MFA code sent to the user's email.
  • mfaToken: Token returned from the original MFA setup or step-up authentication request.
  • rememberDevice (optional): If set to true, the device will be remembered to reduce MFA prompts on future logins from the same client.

Use this endpoint to confirm the MFA challenge and optionally remember the current device for future sessions.

Bodyapplication/jsonrequired
otcTokenstringrequired
codestringrequired
mfaTokenstringrequired
rememberDeviceboolean
curl -i -X POST \
  https://api.frontegg.com/identity/resources/auth/v1/user/mfa/emailcode/verify \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "otcToken": "string",
    "code": "string",
    "mfaToken": "string",
    "rememberDevice": true
  }'

Responses

Pre enroll MFA using Authenticator App

Request

Initiate enrollment in multi-factor authentication (MFA) using an authenticator app (e.g., Google Authenticator, Authy).

This endpoint begins the MFA setup process and returns the necessary data for configuring an authenticator app, such as a QR code or secret key.

The request must include:

  • mfaToken: A token received from the initial authentication flow that authorizes the MFA setup.

Use this endpoint to generate the configuration required for linking an authenticator app before completing verification.

Bodyapplication/jsonrequired
mfaTokenstringrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/auth/v1/user/mfa/authenticator/enroll \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "mfaToken": "string"
  }'

Responses

Passwordless

Operations

SMS

Operations

Account invitations settings

Operations

Core settings

Operations

Custom social OAuth provider

Operations

Data migration

Operations

Delegation

Operations

Email configuration

Operations

Email templates

Operations

M2M tokens

Operations

MFA configuration

Operations

Permissions categories

Operations

Permissions

Operations

Roles

Operations

SMS configuration

Operations

SMS templates

Operations

Sessions configuration

Operations

User pools

Operations

Users

Operations

Account invitations

Operations

Account roles

Operations

API tokens

Operations

Domain restrictions

Operations

IP restrictions

Operations

Lockout policy

Operations

MFA settings

Operations

Password settings

Operations

Personal tokens

Operations

Sessions management

Operations

User groups

Operations

User management

Operations

User sessions

Operations

Users-applications management

Operations