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.

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

Verify MFA enrollment

Request

Complete SMS-based multi-factor authentication (MFA) enrollment for a user.

This endpoint finalizes SMS MFA setup by verifying the code sent to the user's phone.

Request body must include:

  • otcToken: One-time challenge token received from the initial enrollment step.
  • code: The verification code sent to the user's phone via SMS.

Use this endpoint to verify the user's phone number and activate SMS-based MFA for their account.

Headers
frontegg-user-idstringrequired

The user ID identifier

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

Responses

Disable authenticator app MFADeprecated

Request

Disable MFA enrollment for a logged-in user within a specific tenant.

This endpoint disables multi-factor authentication for a user, using the mfaToken obtained from the user's authenticator app.

Use this endpoint to programmatically disable MFA when managing authentication settings at the tenant level.

Headers
frontegg-user-idstringrequired

The user ID identifier

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

Responses

Verify MFA using code from authenticator appDeprecated

Request

Verify a multi-factor authentication (MFA) code generated by an authenticator app during the authentication process.

This endpoint completes the MFA step by validating the provided code.

The request must include:

  • value: The MFA service name (e.g., authenticator), as configured in your Authentication Settings.
  • mfaToken: The time-based one-time password (TOTP) generated by the user's authenticator app.

Use this endpoint to verify the user's MFA code during an authentication challenge, typically after the primary login step.

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

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