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

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

Get users groups

Request

This route gets all users groups for a tenant. Send the tenant’s ID in the frontegg-tenant-id header to declare which tenant.

Query
idsArray of stringsrequired
Headers
frontegg-tenant-idstring

The tenant ID identifier

curl -i -X GET \
  'https://api.frontegg.com/identity/resources/users/v3/groups?ids=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
object(GetUserGroupsResponse)
Response
application/json
{}

Unlock user

Request

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

Responses

Invite user

Request

This route creates a user for a specific tenant. Send the tenant’s ID in the frontegg-tenant-id header to declare to what tenant this user is assigned. Send the user's information in the POST body. The user's email and metadata are required. The metadata can be empty, like {}.

Headers
frontegg-tenant-idstringrequired

The tenant ID identifier

Bodyapplication/jsonrequired
emailstring(email)required
namestring
profilePictureUrlstring<= 4095 characters
passwordstring
phoneNumberstring
providerstring
Default "local"
Enum"local""saml""google""github""facebook""microsoft""scim2""slack""apple"
metadatastring

Stringified JSON object

Example: "{}"
skipInviteEmailboolean
roleIdsArray of strings
emailMetadataobject
expirationInSecondsnumber>= 300

Temporary user expiration in seconds

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v2 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-tenant-id: string' \
  -d '{
    "email": "user@example.com",
    "name": "string",
    "profilePictureUrl": "string",
    "password": "string",
    "phoneNumber": "string",
    "provider": "local",
    "metadata": "{}",
    "skipInviteEmail": true,
    "roleIds": [
      "string"
    ],
    "emailMetadata": {},
    "expirationInSeconds": 300
  }'

Responses

Bodyapplication/json
idstring
emailstring
verifiedboolean
namestring
profilePictureUrlstring
rolesArray of strings
permissionsArray of strings
metadatastring
createdAtstring(date-time)
lastLoginstring(date-time)
activatedForTenantboolean
temporaryExpirationDatestring(date-time)
Response
application/json
{ "id": "string", "email": "string", "verified": true, "name": "string", "profilePictureUrl": "string", "roles": [ "string" ], "permissions": [ "string" ], "metadata": "string", "createdAt": "2019-08-24T14:15:22Z", "lastLogin": "2019-08-24T14:15:22Z", "activatedForTenant": true, "temporaryExpirationDate": "2019-08-24T14:15:22Z" }

User sessions

Operations

Users-applications management

Operations