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.
https://api.frontegg.com/identity/
https://api.us.frontegg.com/identity/
https://api.ca.frontegg.com/identity/
https://api.au.frontegg.com/identity/
https://{domain}.frontegg.com/identity/
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.
https://api.frontegg.com/identity/resources/auth/v1/logout
https://api.us.frontegg.com/identity/resources/auth/v1/logout
https://api.ca.frontegg.com/identity/resources/auth/v1/logout
https://api.au.frontegg.com/identity/resources/auth/v1/logout
https://app-xxx.frontegg.com/identity/resources/auth/v1/logout
curl -i -X POST \
https://api.frontegg.com/identity/resources/auth/v1/logout \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'frontegg-vendor-host: string'Sign up a new user and create a new account (tenant).
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 account (tenant) onboarding or self-sign-up flows.
https://api.frontegg.com/identity/resources/users/v1/signUp
https://api.us.frontegg.com/identity/resources/users/v1/signUp
https://api.ca.frontegg.com/identity/resources/users/v1/signUp
https://api.au.frontegg.com/identity/resources/users/v1/signUp
https://app-xxx.frontegg.com/identity/resources/users/v1/signUp
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",
"username": "string",
"name": "string",
"profilePictureUrl": "string",
"password": "string",
"skipInviteEmail": true,
"roleIds": [
"string"
],
"emailMetadata": {},
"companyName": "string",
"recaptchaToken": "string",
"invitationToken": "string",
"phoneNumber": "string"
}'