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

Add or update template

Request

This route creates or updates an email template. Select the email template using the type. The type value needs to be the name of one of the Frontegg email templates. See the dropdown for available values. Also, set the sender using senderEmail. Optionally, include values for the other available body params. Send the information for the template in the POST body. A vendor token is required for this route, it can be obtained from the vendor authentication route.

Bodyapplication/jsonrequired
typestringrequired
Enum"ResetPassword""ActivateUser""InviteToTenant""PwnedPassword""MagicLink""OTC""ConnectNewDevice""UserUsedInvitation""ResetPhoneNumber""BulkInvitesToTenant"
senderEmailstring
redirectURLstring

Only required for: ResetPassword, ActivateUser, InviteToTenant, MagicLink, BulkInvitesToTenant

htmlTemplatestring<= 100000 characters
subjectstring
fromNamestring
successRedirectUrlstring
activeboolean
curl -i -X POST \
  https://api.frontegg.com/identity/resources/mail/v1/configs/templates \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "ResetPassword",
    "senderEmail": "string",
    "redirectURL": "string",
    "htmlTemplate": "string",
    "subject": "string",
    "fromName": "string",
    "successRedirectUrl": "string",
    "active": true
  }'

Responses

Get template

Request

This route gets all the vendor’s email templates. In order to get a specific template, pass its type as a query param. A vendor token is required for this route, it can be obtained from the vendor authentication route.

Query
typestring
Enum"ResetPassword""ActivateUser""InviteToTenant""PwnedPassword""MagicLink""OTC""ConnectNewDevice""UserUsedInvitation""ResetPhoneNumber""BulkInvitesToTenant"
curl -i -X GET \
  https://api.frontegg.com/identity/resources/mail/v1/configs/templates \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
htmlTemplatestringrequired
senderEmailstringrequired
redirectURLstringrequired
successRedirectUrlstringrequired
subjectstringrequired
fromNamestringrequired
activebooleanrequired
typeobjectrequired
redirectURLPatternstring
successRedirectUrlPatternstring
]
Response
application/json
[ { "htmlTemplate": "string", "senderEmail": "string", "redirectURL": "string", "successRedirectUrl": "string", "subject": "string", "fromName": "string", "active": true, "type": {}, "redirectURLPattern": "string", "successRedirectUrlPattern": "string" } ]

Delete template

Request

This route deletes specified email template. Select the email template using the ID of the template - which can be obtained via the Get template API. A vendor token is required for this route, it can be obtained from the vendor authentication route.

Path
templateIdstringrequired
curl -i -X DELETE \
  'https://api.frontegg.com/identity/resources/mail/v1/configs/templates/{templateId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Get default template by type

Request

This route gets default email template by type, pass required type as a query param.

Path
typestringrequired

The email template type

Enum"ResetPassword""ActivateUser""InviteToTenant""PwnedPassword""MagicLink""OTC""ConnectNewDevice""UserUsedInvitation""ResetPhoneNumber""BulkInvitesToTenant"
curl -i -X GET \
  'https://api.frontegg.com/identity/resources/mail/v1/configs/{type}/default' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
htmlTemplatestringrequired
senderEmailstringrequired
redirectURLstringrequired
successRedirectUrlstringrequired
subjectstringrequired
fromNamestringrequired
activebooleanrequired
typeobjectrequired
redirectURLPatternstring
successRedirectUrlPatternstring
Response
application/json
{ "htmlTemplate": "string", "senderEmail": "string", "redirectURL": "string", "successRedirectUrl": "string", "subject": "string", "fromName": "string", "active": true, "type": {}, "redirectURLPattern": "string", "successRedirectUrlPattern": "string" }

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