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

Authenticate using API token

Request

Authenticate a tenant or user using an API token.

To authenticate, include your clientId and secret in the request body. You can locate these credentials in the Admin Portal âžś API Tokens. Send the request to your Frontegg environment (e.g., https://<your-subdomain>.frontegg.com) rather than the default domain.

Refresh Token Rotation: This endpoint enforces a rotation policy. Each API token supports up to 100 active refresh tokens. When the 101st request is made using the same API token, the oldest refresh token is invalidated.

Use this endpoint to securely authenticate automated services, back-end clients, or integrations that rely on static credentials.

Bodyapplication/jsonrequired
clientIdstringrequired
secretstringrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/auth/v2/api-token \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "string",
    "secret": "string"
  }'

Responses

Bodyapplication/json
access_tokenstringrequired
refresh_tokenstringrequired
expires_innumberrequired
expiresstringrequired
Response
application/json
{ "access_token": "string", "refresh_token": "string", "expires_in": 0, "expires": "string" }

Refresh API token

Request

Refresh a JWT using a valid refresh token.

To obtain a new JWT and refresh token pair, include the refresh token in the request body. This is typically used to maintain an authenticated session without prompting the user to log in again.

If the provided refresh token is valid and not expired, the endpoint returns a new signed JWT and a new refresh token. If the token is invalid or has been revoked due to rotation limits, the request will fail with an authentication error.

Bodyapplication/jsonrequired
refreshTokenstringrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/auth/v2/api-token/token/refresh \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "refreshToken": "string"
  }'

Responses

Bodyapplication/json
access_tokenstringrequired
refresh_tokenstringrequired
expires_innumberrequired
expiresstringrequired
Response
application/json
{ "access_token": "string", "refresh_token": "string", "expires_in": 0, "expires": "string" }

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

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