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

Authenticate user with password

Request

This route authenticates a local user using email and password. Send the frontegg-vendor-host as a header to declare which vendor. This is your domain name in the Frontegg Portal âžś Workspace Settings âžś Domains âžś Domain Name. Optionally, send login information for the user as POST body params. Include the invitation token if the user is signing up by invitation. Send the recaptcha token if the recaptcha is enabled for login.

Headers
frontegg-vendor-hoststring

The vendor host domain

Bodyapplication/jsonrequired
emailstringrequired
passwordstringrequired
recaptchaTokenstring
invitationTokenstring
curl -i -X POST \
  https://api.frontegg.com/identity/resources/auth/v1/user \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "password": "string",
    "recaptchaToken": "string",
    "invitationToken": "string"
  }'

Responses

Bodyapplication/json
tokenTypestring
Default "bearer"
mfaRequiredbooleanrequired
mfaTokenstring
resetPasswordTokenstring
passwordExpiresInnumber
notificationPeriodnumber
mfaEnrolledboolean
mfaDevicesobject(UserMFADevicesResponse)
mfaStrategiesobject
qrCodestring
recoveryCodestring
accessTokenstringrequired
refreshTokenstringrequired
expiresInnumberrequired
expiresstringrequired
userIdstring
userEmailstring
emailVerifiedboolean
isBreachedPasswordboolean
Response
application/json
{ "tokenType": "bearer", "mfaRequired": true, "mfaToken": "string", "resetPasswordToken": "string", "passwordExpiresIn": 0, "notificationPeriod": 0, "mfaEnrolled": true, "mfaDevices": { "webauthn": [ … ], "phones": [ … ], "authenticators": [ … ], "emails": [ … ] }, "mfaStrategies": {}, "qrCode": "string", "recoveryCode": "string", "accessToken": "string", "refreshToken": "string", "expiresIn": 0, "expires": "string", "userId": "string", "userEmail": "string", "emailVerified": true, "isBreachedPassword": true }

Refresh user JWT token

Request

This route refreshes a JWT based on the refresh token expiration time. If the refresh token is valid, the route returns a new JWT and refresh token. Please note that the route expects the refresh cookie of the logged in user as well. Send the frontegg-vendor-host as a header to declare which vendor. This is your domain name in the Frontegg Portal âžś Workspace Settings âžś Domains âžś Domain Name. Configure your JWT settings in the Frontegg Portal.

Headers
frontegg-vendor-hoststringrequired
Bodyapplication/jsonrequired
object(RefreshTokenDto)
curl -i -X POST \
  https://api.frontegg.com/identity/resources/auth/v1/user/token/refresh \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-vendor-host: string' \
  -d '{}'

Responses

Bodyapplication/json
tokenTypestring
Default "bearer"
mfaRequiredbooleanrequired
mfaTokenstring
resetPasswordTokenstring
passwordExpiresInnumber
notificationPeriodnumber
mfaEnrolledboolean
mfaDevicesobject(UserMFADevicesResponse)
mfaStrategiesobject
qrCodestring
recoveryCodestring
accessTokenstringrequired
refreshTokenstringrequired
expiresInnumberrequired
expiresstringrequired
userIdstring
userEmailstring
emailVerifiedboolean
isBreachedPasswordboolean
Response
application/json
{ "tokenType": "bearer", "mfaRequired": true, "mfaToken": "string", "resetPasswordToken": "string", "passwordExpiresIn": 0, "notificationPeriod": 0, "mfaEnrolled": true, "mfaDevices": { "webauthn": [ … ], "phones": [ … ], "authenticators": [ … ], "emails": [ … ] }, "mfaStrategies": {}, "qrCode": "string", "recoveryCode": "string", "accessToken": "string", "refreshToken": "string", "expiresIn": 0, "expires": "string", "userId": "string", "userEmail": "string", "emailVerified": true, "isBreachedPassword": true }

Logout user

Request

This route logs out a user using the refresh token that is passed as a cookie. Send the frontegg-vendor-host as a header to declare which vendor. This route is designed for Frontegg embedded login or integrations that use only Frontegg APIs

Headers
frontegg-vendor-hoststringrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/auth/v1/logout \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'frontegg-vendor-host: string'

Responses

Signup user

Request

This route is for signing up a new user and new account (tenant). Send the user's information in the POST body. The provider is the authentication provider, like local, saml, google, github. See the dropdown for available values. The metadata can be empty, like {}. You also can send in the POST body additional information as shown in the example.

Headers
frontegg-vendor-hoststringrequired
frontegg-application-idstringrequired

The application id

Bodyapplication/jsonrequired
providerstringrequired
Enum"local""saml""google""github""facebook""microsoft""scim2""slack""apple"
metadatastring

Stringified JSON object. Use the JSON.stringify() method.

emailstringrequired
namestring
profilePictureUrlstring<= 4095 characters
passwordstring
skipInviteEmailboolean
roleIdsArray of strings
emailMetadataobject
companyNamestringrequired
recaptchaTokenstring
invitationTokenstring
phoneNumberstring
curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v1/signUp \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-application-id: string' \
  -H 'frontegg-vendor-host: string' \
  -d '{
    "provider": "local",
    "metadata": "string",
    "email": "string",
    "name": "string",
    "profilePictureUrl": "string",
    "password": "string",
    "skipInviteEmail": true,
    "roleIds": [
      "string"
    ],
    "emailMetadata": {},
    "companyName": "string",
    "recaptchaToken": "string",
    "invitationToken": "string",
    "phoneNumber": "string"
  }'

Responses

Response
application/json
{ "provider": "local", "metadata": "string", "email": "string", "name": "string", "profilePictureUrl": "string", "password": "string", "skipInviteEmail": true, "roleIds": [ "string" ], "emailMetadata": {}, "companyName": "string", "recaptchaToken": "string", "invitationToken": "string", "phoneNumber": "string" }

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