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

Create domain restriction

Request

This route creates a new domain restriction for a tenant. Send values in the POST body as objects. See the dropdowns for available values for each object param.

Bodyapplication/jsonrequired
domainstringdomainRegexrequired
typestringrequired
Enum"ALLOW""BLOCK"
curl -i -X POST \
  https://api.frontegg.com/identity/resources/configurations/restrictions/v1/email-domain \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "domain": "string",
    "type": "ALLOW"
  }'

Responses

Bodyapplication/json
idstringrequired
domainstringrequired
typestringrequired
Enum"ALLOW""BLOCK"
Response
application/json
{ "id": "string", "domain": "string", "type": "ALLOW" }

Get domain restrictions

Request

This route gets the domain restrictions for a tenant.

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

Responses

Bodyapplication/json
idstringrequired
domainstringrequired
typestringrequired
Enum"ALLOW""BLOCK"
Response
application/json
{ "id": "string", "domain": "string", "type": "ALLOW" }

Get domain restrictions

Request

This route gets the domain restrictions for a tenant.

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

Responses

Bodyapplication/json
activebooleanrequired
listTypestringrequired
Enum"ALLOW""BLOCK"
blockPublicDomainsbooleanrequired
Response
application/json
{ "active": true, "listType": "ALLOW", "blockPublicDomains": true }

Change domain restrictions config list type and toggle it off/on

Request

This route updates domain restrictions config, can toggle check on/off.

Bodyapplication/jsonrequired
activebooleanrequired
blockPublicDomainsboolean
typestring
Enum"ALLOW""BLOCK"
curl -i -X POST \
  https://api.frontegg.com/identity/resources/configurations/restrictions/v1/email-domain/config \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "active": true,
    "blockPublicDomains": true,
    "type": "ALLOW"
  }'

Responses

Bodyapplication/json
activebooleanrequired
listTypestringrequired
Enum"ALLOW""BLOCK"
blockPublicDomainsbooleanrequired
Response
application/json
{ "active": true, "listType": "ALLOW", "blockPublicDomains": true }

Delete domain restriction

Request

This route deletes domain restriction.

Path
idstringrequired
curl -i -X DELETE \
  'https://api.frontegg.com/identity/resources/configurations/restrictions/v1/email-domain/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Replace bulk domain restriction

Request

This route replaces all domains from the incoming request

Bodyapplication/jsonrequired
typestringrequired
Enum"ALLOW""BLOCK"
domainsArray of stringsrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/configurations/restrictions/v1/email-domain/replace-bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "ALLOW",
    "domains": [
      "string"
    ]
  }'

Responses

Bodyapplication/jsonArray [
idstringrequired
domainstringrequired
typestringrequired
Enum"ALLOW""BLOCK"
]
Response
application/json
[ { "id": "string", "domain": "string", "type": "ALLOW" } ]

IP restrictions

Operations

Lockout policy

Operations

Password settings

Operations

Personal tokens

Operations