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

Get tenant invite of user

Request

This route gets an invitation for a specific user to join a tenant. Send the user’s ID in the frontegg-user-id header and the tenant’s ID in the frontegg-tenant-id header.

Headers
frontegg-user-idstringrequired

The user ID identifier

frontegg-tenant-idstringrequired

The tenant ID identifier

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

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" }

Create tenant invite for user

Request

This route creates an invitation for a specific user to join a tenant. Send the user’s ID in the frontegg-user-id header and the tenant’s ID in the frontegg-tenant-id header. To create a general invitation, use the general invitation route.

Headers
frontegg-user-idstringrequired

The user ID identifier

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired
expiresInMinutesnumberrequired
shouldSendEmailbooleanrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/tenants/invites/v1/user \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -H 'frontegg-user-id: string' \
  -d '{
    "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" }

Delete tenant invite of user

Request

This route deletes an invitation for a specific user to join a tenant. Send the user’s ID in the frontegg-user-id header and the tenant’s ID in the frontegg-tenant-id header. To delete a general invitation, use the general invitation route.

Headers
frontegg-user-idstringrequired

The user ID identifier

frontegg-tenant-idstringrequired

The tenant ID identifier

curl -i -X DELETE \
  https://api.frontegg.com/identity/resources/tenants/invites/v1/user \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'frontegg-tenant-id: string' \
  -H 'frontegg-user-id: string'

Responses

Update tenant invite of user

Request

This route updates an invitation for a specific user to join a tenant. In order to set up a specific expiration time, use the expiresInMinutes to declare when the invite is being invalidated. The shouldSendEmail boolean declares wether an invitation email will be sent or not. Send the user’s ID in the frontegg-user-id header and the tenant’s ID in the frontegg-tenant-id header. A vendor token is required for this route, it can be obtained from the vendor authentication route.

Headers
frontegg-user-idstringrequired

The user ID identifier

frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired
expiresInMinutesnumber
shouldSendEmailboolean
curl -i -X PATCH \
  https://api.frontegg.com/identity/resources/tenants/invites/v1/user \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -H 'frontegg-user-id: string' \
  -d '{
    "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" }

Verify tenant invite

Request

This route verifies a tenant invitation. Pass the invitation token as the token param. A vendor token is required for this route, it can be obtained from the vendor authentication route.

Bodyapplication/jsonrequired
tokenstringrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/tenants/invites/v1/verify \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "string"
  }'

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 tenant invite configuration

Request

This route checks whether account (tenant) invitations are enabled on the environment and whether notifications are active. An environment token is required for this route, it can be obtained from the environment authentication route.

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

Responses

Bodyapplication/json
tenantInvitationsAllowedbooleanrequired
emailsEnabledbooleanrequired
Response
application/json
{ "tenantInvitationsAllowed": true, "emailsEnabled": true }

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