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

Logout user

Request

Log out a user by invalidating their refresh token.

This endpoint logs out the currently authenticated user by invalidating the refresh token provided in the refresh token cookie.

This route is intended for applications using Frontegg's embedded login experience or for integrations that interact exclusively with 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

Sign up a new user and create a new tenant account.

This endpoint registers a user with authentication details such as email, password, and the provider used for authentication (e.g., local, saml, google, github). Refer to the documentation or dropdown menu for the full list of supported provider values.

Additional optional fields such as user metadata may also be included. If not needed, metadata can be passed as an empty object (e.g., {}).

This endpoint is typically used during tenant onboarding or self-sign-up flows.

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
No content

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