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/
This route retrieves all users for a specific tenant or environment. To filter by tenant, include the tenant's ID in the frontegg-tenant-id header; otherwise, leave it empty to retrieve users from all tenants. In addition to all standard Get users query params, this route supports phrase search, allowing for complex queries using parameters such as contains, excludes, optional and approximate matching.
when passing a user id, gives the option to include or not include sub tenants when searching users
Pass a list of strings, separated by comma, to search for users that contain all of the strings in the list
Pass a list of strings, separated by comma, to search for users that do not contain any of the strings in the list
Pass a list of strings, separated by comma, to search for users that contain at least one of the strings in the list
When true, the search will be approximate (fuzzy), meaning it will include similar characters to the ones in the search string
https://api.frontegg.com/identity/resources/users/v1/query/phrase
https://api.us.frontegg.com/identity/resources/users/v1/query/phrase
https://api.ca.frontegg.com/identity/resources/users/v1/query/phrase
https://api.au.frontegg.com/identity/resources/users/v1/query/phrase
https://app-xxx.frontegg.com/identity/resources/users/v1/query/phrase
curl -i -X GET \
https://api.frontegg.com/identity/resources/users/v1/query/phrase \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "items": [ { … } ], "_links": { "next": "string", "prev": "string", "first": "string", "last": "string" }, "_metadata": { "totalItems": 0, "totalPages": 0 } }
https://api.frontegg.com/identity/resources/usernames/v1
https://api.us.frontegg.com/identity/resources/usernames/v1
https://api.ca.frontegg.com/identity/resources/usernames/v1
https://api.au.frontegg.com/identity/resources/usernames/v1
https://app-xxx.frontegg.com/identity/resources/usernames/v1
curl -i -X GET \
https://api.frontegg.com/identity/resources/usernames/v1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "username": "user.name", "userId": "user-id" }
https://api.frontegg.com/identity/resources/usernames/v1
https://api.us.frontegg.com/identity/resources/usernames/v1
https://api.ca.frontegg.com/identity/resources/usernames/v1
https://api.au.frontegg.com/identity/resources/usernames/v1
https://app-xxx.frontegg.com/identity/resources/usernames/v1
curl -i -X POST \
https://api.frontegg.com/identity/resources/usernames/v1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"username": "john.doe$!#-+'\''~_"
}'