Skip to content
/Core settings

Authentication and Identity Management (1.0)

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

Passwordless

Operations

SMS

Operations

Account invitations settings

Operations

Core settings

Operations

Update identity management configuration

Request

Update the identity management configuration for your environment.

Use this endpoint to add or update identity management parameters by sending the desired values in the request body.

Refer to the parameter documentation for the list of supported values.

Security warning: Setting addPermissionsToJwt to false removes permission claims from the issued JWT. If your API routes rely on those claims for permission-based authorization, they may no longer be protected, and a user with no permissions could gain admin-equivalent read and write access. Only disable it if you enforce authorization by another means.

Security
bearer
Bodyapplication/jsonrequired
defaultTokenExpirationnumber>= 10
defaultRefreshTokenExpirationnumber<= 15552000
cookieSameSitestring
Enum"STRICT""LAX""NONE"
machineToMachineAuthStrategystring
Enum"ClientCredentials""AccessToken"
allowSignupsboolean
apiTokensEnabledboolean
allowOverridePasswordComplexityboolean
allowOverridePasswordExpirationboolean
allowOverrideEnforcePasswordHistoryboolean
jwtAlgorithmstring
Enum"HS256""RS256"
allowNotVerifiedUsersLoginboolean
forcePermissionsboolean
addSamlAttributesToJwtboolean
authStrategystring
Enum"Code""EmailAndPassword""MagicLink""NoLocalAuthentication""SmsCode"
defaultPasswordlessTokenExpirationnumber
forceSameDeviceOnAuthboolean
allowTenantInvitationsboolean
rotateRefreshTokensboolean
skipTenantValidationboolean
addRolesToJwtboolean
addPermissionsToJwtboolean

Controls whether permission claims are included in the issued JWT. When true, the user's permissions are added to the token.

Security warning: Setting this to false removes the permission claims from the issued JWT. If your API routes rely on those claims for permission-based authorization, they may no longer be protected, and a user with no permissions could gain admin-equivalent read and write access. Only disable this if you enforce authorization by another means.

allowCustomLoginTenantSwitchboolean
curl -i -X POST \
  https://api.frontegg.com/identity/resources/configurations/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "defaultTokenExpiration": 10,
    "defaultRefreshTokenExpiration": 15552000,
    "cookieSameSite": "STRICT",
    "machineToMachineAuthStrategy": "ClientCredentials",
    "allowSignups": true,
    "apiTokensEnabled": true,
    "allowOverridePasswordComplexity": true,
    "allowOverridePasswordExpiration": true,
    "allowOverrideEnforcePasswordHistory": true,
    "jwtAlgorithm": "HS256",
    "allowNotVerifiedUsersLogin": true,
    "forcePermissions": true,
    "addSamlAttributesToJwt": true,
    "authStrategy": "Code",
    "defaultPasswordlessTokenExpiration": 0,
    "forceSameDeviceOnAuth": true,
    "allowTenantInvitations": true,
    "rotateRefreshTokens": true,
    "skipTenantValidation": true,
    "addRolesToJwt": true,
    "addPermissionsToJwt": true,
    "allowCustomLoginTenantSwitch": true
  }'

Responses

Bodyapplication/json
idstringrequired
defaultTokenExpirationnumberrequired
defaultRefreshTokenExpirationnumberrequired
publicKeystringrequired
cookieSameSitestringrequired
Enum"STRICT""LAX""NONE"
allowSignupsbooleanrequired
apiTokensEnabledbooleanrequired
allowOverridePasswordComplexitybooleanrequired
allowOverridePasswordExpirationbooleanrequired
allowOverrideEnforcePasswordHistorybooleanrequired
jwtAlgorithmstringrequired
Enum"RS256""HS256"
jwtSecretstringrequired
allowNotVerifiedUsersLoginbooleanrequired
forcePermissionsbooleanrequired
authStrategystringrequired
Enum"EmailAndPassword""MagicLink""Code""NoLocalAuthentication""SmsCode""UsernameAndPassword""UsernameAndMagicLink""UsernameAndCode""UsernameAndSms"
defaultPasswordlessTokenExpirationnumberrequired
forceSameDeviceOnAuthbooleanrequired
allowTenantInvitationsbooleanrequired
rotateRefreshTokensbooleanrequired
machineToMachineAuthStrategystringrequired
Enum"ClientCredentials""AccessToken"
addRolesToJwtbooleanrequired
addPermissionsToJwtbooleanrequired
refreshTokensRotationLimitnumberrequired
addSamlAttributesToJwtbooleanrequired
allowCustomLoginTenantSwitchbooleanrequired
Response
application/json
{
  "id": "string",
  "defaultTokenExpiration": 0,
  "defaultRefreshTokenExpiration": 0,
  "publicKey": "string",
  "cookieSameSite": "STRICT",
  "allowSignups": true,
  "apiTokensEnabled": true,
  "allowOverridePasswordComplexity": true,
  "allowOverridePasswordExpiration": true,
  "allowOverrideEnforcePasswordHistory": true,
  "jwtAlgorithm": "RS256",
  "jwtSecret": "string",
  "allowNotVerifiedUsersLogin": true,
  "forcePermissions": true,
  "authStrategy": "EmailAndPassword",
  "defaultPasswordlessTokenExpiration": 0,
  "forceSameDeviceOnAuth": true,
  "allowTenantInvitations": true,
  "rotateRefreshTokens": true,
  "machineToMachineAuthStrategy": "ClientCredentials",
  "addRolesToJwt": true,
  "addPermissionsToJwt": true,
  "refreshTokensRotationLimit": 0,
  "addSamlAttributesToJwt": true,
  "allowCustomLoginTenantSwitch": true
}

Get identity management configuration

Request

Retrieve the identity management configuration for your environment.

Use this endpoint to get the current identity management settings configured in your environment.

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

Responses

Bodyapplication/json
idstringrequired
defaultTokenExpirationnumberrequired
defaultRefreshTokenExpirationnumberrequired
publicKeystringrequired
cookieSameSitestringrequired
Enum"STRICT""LAX""NONE"
allowSignupsbooleanrequired
apiTokensEnabledbooleanrequired
allowOverridePasswordComplexitybooleanrequired
allowOverridePasswordExpirationbooleanrequired
allowOverrideEnforcePasswordHistorybooleanrequired
jwtAlgorithmstringrequired
Enum"RS256""HS256"
jwtSecretstringrequired
allowNotVerifiedUsersLoginbooleanrequired
forcePermissionsbooleanrequired
authStrategystringrequired
Enum"EmailAndPassword""MagicLink""Code""NoLocalAuthentication""SmsCode""UsernameAndPassword""UsernameAndMagicLink""UsernameAndCode""UsernameAndSms"
defaultPasswordlessTokenExpirationnumberrequired
forceSameDeviceOnAuthbooleanrequired
allowTenantInvitationsbooleanrequired
rotateRefreshTokensbooleanrequired
machineToMachineAuthStrategystringrequired
Enum"ClientCredentials""AccessToken"
addRolesToJwtbooleanrequired
addPermissionsToJwtbooleanrequired
refreshTokensRotationLimitnumberrequired
addSamlAttributesToJwtbooleanrequired
allowCustomLoginTenantSwitchbooleanrequired
Response
application/json
{
  "id": "string",
  "defaultTokenExpiration": 0,
  "defaultRefreshTokenExpiration": 0,
  "publicKey": "string",
  "cookieSameSite": "STRICT",
  "allowSignups": true,
  "apiTokensEnabled": true,
  "allowOverridePasswordComplexity": true,
  "allowOverridePasswordExpiration": true,
  "allowOverrideEnforcePasswordHistory": true,
  "jwtAlgorithm": "RS256",
  "jwtSecret": "string",
  "allowNotVerifiedUsersLogin": true,
  "forcePermissions": true,
  "authStrategy": "EmailAndPassword",
  "defaultPasswordlessTokenExpiration": 0,
  "forceSameDeviceOnAuth": true,
  "allowTenantInvitations": true,
  "rotateRefreshTokens": true,
  "machineToMachineAuthStrategy": "ClientCredentials",
  "addRolesToJwt": true,
  "addPermissionsToJwt": true,
  "refreshTokensRotationLimit": 0,
  "addSamlAttributesToJwt": true,
  "allowCustomLoginTenantSwitch": true
}

Create captcha policy

Request

Create a CAPTCHA policy for all accounts (tenants).

Provide the required settings in the request body. To enable the policy, set the enabled parameter to true, and provide the siteKey and secretKey obtained from reCAPTCHA. You can also set the minimumScore parameter to a value between 0 and 1 to define the minimum score threshold.

Security
bearer
Bodyapplication/jsonrequired
enabledbooleanrequired
siteKeystringrequired
secretKeystringrequired
minScorenumberrequired
ignoredEmailsArray of strings

Captcha validation will be skipped for those emails.

curl -i -X POST \
  https://api.frontegg.com/identity/resources/configurations/v1/captcha-policy \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true,
    "siteKey": "string",
    "secretKey": "string",
    "minScore": 0,
    "ignoredEmails": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired
siteKeystringrequired
secretKeystringrequired
enabledbooleanrequired
minScorenumberrequired
ignoredEmailsArray of stringsrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
Response
application/json
{
  "id": "string",
  "siteKey": "string",
  "secretKey": "string",
  "enabled": true,
  "minScore": 0,
  "ignoredEmails": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}

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