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

Request to verify MFA using sms

Request

Verify multi-factor authentication (MFA) using an SMS-based device.

This endpoint confirms the SMS MFA challenge as part of the authentication or step-up verification process for a specific registered device.

Path parameters:

  • deviceId: The unique identifier of the SMS MFA device being verified.

Request body must include:

  • mfaToken: Token provided during the authentication or challenge flow.

Use this endpoint to complete SMS-based MFA verification for the specified device.

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

Responses

Verify MFA using sms

Request

Verify a multi-factor authentication (MFA) challenge using an SMS code for a specific registered device.

This endpoint finalizes the MFA step by validating the SMS code and may mark the device as trusted if specified.

Path parameters:

  • deviceId: The unique identifier of the SMS MFA device being verified.

Request body must include:

  • otcToken: Token received from the SMS MFA challenge initiation.
  • code: The verification code sent to the user's phone via SMS.
  • mfaToken: MFA token issued during the initial login or step-up challenge.
  • rememberDevice (optional): Set to true to remember the device and reduce future MFA prompts on this device.

Use this endpoint to complete SMS-based MFA verification and optionally trust the device for future logins.

Path
deviceIdstringrequired
Bodyapplication/jsonrequired
otcTokenstringrequired
codestringrequired
mfaTokenstringrequired
rememberDeviceboolean
curl -i -X POST \
  'https://api.frontegg.com/identity/resources/auth/v1/user/mfa/sms/{deviceId}/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 WebAuthN

Request

Initiate multi-factor authentication (MFA) enrollment using WebAuthn (e.g., security keys, biometrics).

This endpoint begins the WebAuthn MFA setup by returning a browser-based challenge needed to link a trusted device, such as a biometric reader or hardware security key.

The request must include:

  • mfaToken: Token issued during the authentication flow to authorize MFA setup.

Use this endpoint as the first step when enrolling a user in WebAuthn-based MFA.

Bodyapplication/jsonrequired
mfaTokenstringrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/auth/v1/user/mfa/webauthn/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