Users, auth and security module
/
User management
/
Signup user

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.

Download OpenAPI description
Users, Auth and Security
Single Sign-On
SCIM Provisioning
Entitlements
Entitlements Agent
Accounts (Tenants)
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

Account roles

Operations

API tokens

Operations

Domain restrictions

Operations

IP restrictions

Operations

Lockout policy

Operations

Password settings

Operations

Personal tokens

Operations

Sessions management

Operations

User groups

Operations

User management

Operations

Disable user tenant

Request

This route disable a user. A disabled user cannot log in to the tenant or use the system. To disable a user, call this route and send the user’s ID as a path params.

Path
userIdstringrequired
curl -i -X POST \
  'https://api.frontegg.com/identity/resources/tenants/users/v1/{userId}/disable' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Enable user tenant

Request

This route enables a disabled user. An enabled user can log in and use the system. To enable a user, call this route and send the user’s ID as a path params.

Path
userIdstringrequired
curl -i -X POST \
  'https://api.frontegg.com/identity/resources/tenants/users/v1/{userId}/enable' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Sets a permanent user to temporary

Request

This route updates the settings for temporary users, use it to enable or disable it for an environment

Path
userIdstringrequired
Bodyapplication/jsonrequired
expirationInSecondsnumber>= 300required
curl -i -X PUT \
  'https://api.frontegg.com/identity/resources/users/temporary/v1/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "expirationInSeconds": 300
  }'

Responses

Bodyapplication/json
expirationInSecondsnumber>= 300required
Response
application/json
{
  "expirationInSeconds": 300
}

Sets a temporary user to permanent

Request

This route sets an existing temporary user as permanent. Send the user’s ID as a path params.

Path
userIdstringrequired
curl -i -X DELETE \
  'https://api.frontegg.com/identity/resources/users/temporary/v1/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Gets temporary users configuration

Request

This route get the settings for temporary users, use it to check whether the policy is's enabled or disabled

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

Responses

Bodyapplication/json
enabledbooleanrequired
Response
application/json
{
  "enabled": true
}

Set sub-account access for a user

Request

This route sets sub-account access for users as true or false

Path
userIdstringrequired
Bodyapplication/jsonrequired
allowAccessbooleanrequired
curl -i -X PUT \
  'https://api.frontegg.com/identity/resources/sub-tenants/users/v1/{userId}/access' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "allowAccess": true
  }'

Responses

Reset user activation token

Request

This route resets the activation token for a user and triggers a new activation email being sent to the user’s email.

Bodyapplication/jsonrequired
emailstring(email)required
emailMetadataobjectrequired