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

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

Create MFA policy

Request

This route creates the MFA policy globally or for a specific tenant. To create an MFA policy for a specific tenant, send the tenant’s ID in the frontegg-tenant-id header.

Headers
frontegg-tenant-idstring

The tenant ID identifier

Bodyapplication/jsonrequired
enforceMFATypestring

Determine whether MFA should be enforced.

Default "Force"
Enum"DontForce""Force""ForceExceptSAML"
allowRememberMyDeviceboolean

Determine whether devices can be remembered and authentication can be skipped.

Default false
mfaDeviceExpirationnumber

Expiration time of device in seconds

Default 1209600
curl -i -X POST \
  https://api.frontegg.com/identity/resources/configurations/v1/mfa-policy \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enforceMFAType": "DontForce",
    "allowRememberMyDevice": false,
    "mfaDeviceExpiration": 1209600
  }'

Responses

Bodyapplication/json
idstringrequired
enforceMFATypestring
allowRememberMyDevicebooleanrequired
mfaDeviceExpirationnumberrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
Response
application/json
{ "id": "string", "enforceMFAType": "string", "allowRememberMyDevice": true, "mfaDeviceExpiration": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

Update security policy

Request

This route updates the MFA policy for all tenants. To update an MFA policy for a specific tenant, send the tenant’s ID in the frontegg-tenant-id header.

Headers
frontegg-tenant-idstring

The tenant ID identifier

Bodyapplication/jsonrequired
enforceMFATypestring

Determine whether MFA should be enforced.

Default "Force"
Enum"DontForce""Force""ForceExceptSAML"
allowRememberMyDeviceboolean

Determine whether devices can be remembered and authentication can be skipped.

Default false
mfaDeviceExpirationnumber

Expiration time of device in seconds

Default 1209600
curl -i -X PATCH \
  https://api.frontegg.com/identity/resources/configurations/v1/mfa-policy \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enforceMFAType": "DontForce",
    "allowRememberMyDevice": false,
    "mfaDeviceExpiration": 1209600
  }'

Responses

Bodyapplication/json
idstringrequired
enforceMFATypestring
allowRememberMyDevicebooleanrequired
mfaDeviceExpirationnumberrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
Response
application/json
{ "id": "string", "enforceMFAType": "string", "allowRememberMyDevice": true, "mfaDeviceExpiration": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

Upsert security policy

Request

This route creates or updates the MFA policy for all tenants. To create or update an MFA policy for a specific tenant, send the tenant’s ID in the frontegg-tenant-id header.

Headers
frontegg-tenant-idstring

The tenant ID identifier

Bodyapplication/jsonrequired
enforceMFATypestring

Determine whether MFA should be enforced.

Default "Force"
Enum"DontForce""Force""ForceExceptSAML"
allowRememberMyDeviceboolean

Determine whether devices can be remembered and authentication can be skipped.

Default false
mfaDeviceExpirationnumber

Expiration time of device in seconds

Default 1209600
curl -i -X PUT \
  https://api.frontegg.com/identity/resources/configurations/v1/mfa-policy \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enforceMFAType": "DontForce",
    "allowRememberMyDevice": false,
    "mfaDeviceExpiration": 1209600
  }'

Responses

Bodyapplication/json
idstringrequired
enforceMFATypestring
allowRememberMyDevicebooleanrequired
mfaDeviceExpirationnumberrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
Response
application/json
{ "id": "string", "enforceMFAType": "string", "allowRememberMyDevice": true, "mfaDeviceExpiration": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

Get security policy

Request

This route gets the MFA policy for all tenants. To get the MFA policy for a specific tenant, send the tenant’s ID in the frontegg-tenant-id header.

Headers
frontegg-tenant-idstring

The tenant ID identifier

curl -i -X GET \
  https://api.frontegg.com/identity/resources/configurations/v1/mfa-policy \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstringrequired
enforceMFATypestring
allowRememberMyDevicebooleanrequired
mfaDeviceExpirationnumberrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
Response
application/json
{ "id": "string", "enforceMFAType": "string", "allowRememberMyDevice": true, "mfaDeviceExpiration": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

Get MFA strategies

Request

curl -i -X GET \
  https://api.frontegg.com/identity/resources/configurations/v1/mfa/strategies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
strategiesArray of objects(MFAStrategyResponse)required
strategies[].​strategystringrequired
Enum"AuthenticatorApp""WebAuthnPlatform""WebAuthnCrossPlatform""SMS""EmailCode"
strategies[].​isActivebooleanrequired
Response
application/json
{ "strategies": [ { … } ] }

Create or update MFA strategy

Request

Bodyapplication/jsonrequired
isActivebooleanrequired
strategystringrequired
Enum"AuthenticatorApp""WebAuthnPlatform""WebAuthnCrossPlatform""SMS""EmailCode"
curl -i -X POST \
  https://api.frontegg.com/identity/resources/configurations/v1/mfa/strategies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "isActive": true,
    "strategy": "AuthenticatorApp"
  }'

Responses

Password settings

Operations

Personal tokens

Operations

Sessions management

Operations

User groups

Operations

User management

Operations

User sessions

Operations

Users-applications management

Operations