Users, auth and security module

/

/

Verify authenticator app MFA enrollment

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

SCIM Provisioning

Entitlements Agent

Accounts (Tenants)

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

Enroll authenticator app MFA

Request

Enroll a logged-in user in multi-factor authentication (MFA) for a specific tenant.

This endpoint initiates MFA enrollment on behalf of a user within a specific tenant context.

Use this route to programmatically trigger MFA enrollment, typically as part of an administrative or backend workflow.

Headers

frontegg-user-idstringrequired

The user ID identifier

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/mfa/authenticator/enroll \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'frontegg-user-id: string'

Responses

Bodyapplication/json

qrCodestringrequired

QR code to be verified by authenticator app

Response

application/json

{
  "qrCode": "string"
}

Verify authenticator app MFA enrollment

Request

Verify multi-factor authentication (MFA) enrollment using a QR code for a specific user within a tenant.

This endpoint completes MFA enrollment after the user scans a QR code with an authenticator app (e.g., Google Authenticator, Authy).

Request body must include:

mfaToken: The time-based one-time password (TOTP) generated by the authenticator app after scanning the QR code.

Use this endpoint to confirm that the user has successfully registered their authenticator app and to activate MFA for their account.

Headers

frontegg-user-idstringrequired

The user ID identifier

Bodyapplication/jsonrequired

tokenstringrequired

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

Responses

Bodyapplication/json

recoveryCodestringrequired

Response

application/json

{
  "recoveryCode": "string"
}

Enroll SMS MFA

Request

Enroll a user in SMS-based multi-factor authentication (MFA).

This endpoint initiates SMS MFA enrollment by sending a verification code to the user's phone number.

Request body must include:

phoneNumber: The user's mobile number in international format. Must match the validation pattern defined by phoneNumberRegexp.

Use this endpoint to begin the SMS MFA setup process for a specific user. The next step is to verify the SMS code to complete enrollment.

Headers

frontegg-user-idstringrequired

The user ID identifier

Bodyapplication/jsonrequired

phoneNumberstringphoneNumberRegexprequired

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/mfa/sms/enroll \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-user-id: string' \
  -d '{
    "phoneNumber": "string"
  }'

Responses

Passwordless

Operations

SMS

Operations

Account invitations settings

Operations

Core settings

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