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

Create tenant invite

Request

This route creates a general invitation token. To create an invitation token for a specific tenant, send the tenant’s ID in the request’s body. To create an invitation token for a specific user of a tenant, you can add the user ID on the body params. If a user ID was provided, you can decide wether to send an email to the user or not via the shouldSendEmail param. In order to set up a specific expiration time, use the expiresInMinutes to declare when the invite is being invalidated. A vendor token is required for this route, it can be obtained from the vendor authentication route.

Bodyapplication/jsonrequired
tenantIdstringrequired
userIdstring
expiresInMinutesnumber
shouldSendEmailboolean
curl -i -X POST \
  https://api.frontegg.com/identity/resources/tenants/invites/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tenantId": "string",
    "userId": "string",
    "expiresInMinutes": 0,
    "shouldSendEmail": true
  }'

Responses

Bodyapplication/json
idstringrequired
vendorIdstringrequired
tenantIdstringrequired
userIdstring
tokenstringrequired
expiresstring(date-time)required
shouldSendEmailbooleanrequired
namestring
Response
application/json
{ "id": "string", "vendorId": "string", "tenantId": "string", "userId": "string", "token": "string", "expires": "2019-08-24T14:15:22Z", "shouldSendEmail": true, "name": "string" }

Get all tenant invites

Request

This route gets all invitations for all tenants. A vendor token is required for this route, it can be obtained from the vendor authentication route.

curl -i -X GET \
  https://api.frontegg.com/identity/resources/tenants/invites/v1/all \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
idstringrequired
vendorIdstringrequired
tenantIdstringrequired
userIdstring
tokenstringrequired
expiresstring(date-time)required
shouldSendEmailbooleanrequired
namestring
]
Response
application/json
[ { "id": "string", "vendorId": "string", "tenantId": "string", "userId": "string", "token": "string", "expires": "2019-08-24T14:15:22Z", "shouldSendEmail": true, "name": "string" } ]

Delete a tenant invite

Request

This route deletes an invitation to join a tenant using the invitation ID. You can find it via the Get all tenant invites API. Send the invitation ID as a path param - you can get if via the Get all tenant invites API. A vendor token is required for this route, it can be obtained from the vendor authentication route.

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

Responses

Get activation strategies

Request

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

Responses

Bodyapplication/json
strategystringrequired
Enum"code""link"
codeExpirationnumberrequired
Response
application/json
{ "strategy": "code", "codeExpiration": 0 }

Create or update activation strategy

Request

Bodyapplication/jsonrequired
codeExpirationnumber>= 60
strategystringrequired
Enum"code""link"
curl -i -X POST \
  https://api.frontegg.com/identity/resources/configurations/v1/activation/strategies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "codeExpiration": 60,
    "strategy": "code"
  }'

Responses

Get invitation strategies

Request

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

Responses

Bodyapplication/json
strategystringrequired
Enum"code""link"
codeExpirationnumberrequired
Response
application/json
{ "strategy": "code", "codeExpiration": 0 }

Create or update invitation strategy

Request

Bodyapplication/jsonrequired
codeExpirationnumber
curl -i -X POST \
  https://api.frontegg.com/identity/resources/configurations/v1/invitation/strategies \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "codeExpiration": 0
  }'

Responses

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