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 account (tenant) invite

Request

Create a general or account (tenant)-specific invitation token.

Use this endpoint to generate invitation tokens for accounts (tenants) or individual users.

To create a general invitation token, send the request without specifying an account (tenant) or user. To create an account (tenant)-specific token, include the account (tenant) ID in the request body. To create a token for a specific user of an account (tenant), also include the user ID in the body parameters. If a user ID is provided, you can control whether an invitation email is sent by setting the shouldSendEmail parameter.

To set a custom expiration time for the invitation, use the expiresInMinutes parameter to define when the token will expire.

A valid environment token is required to call this endpoint. You can obtain it from the environment 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 account (tenant) invites

Request

Retrieve all invitation tokens across all accounts (tenants).

A valid environment token is required to call this endpoint. You can obtain it from the environment 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 an account (tenant) invite

Request

Delete an invitation for an account (tenant) using the invitation ID.

Use this endpoint to delete a specific invitation by providing its invitation ID as a path parameter. You can obtain the invitation ID via the Get all account (tenant) invites API.

A valid environment token is required to call this endpoint. You can obtain it from the environment 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

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