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/
https://api.frontegg.com/identity/resources/users/v1/{id}
https://api.us.frontegg.com/identity/resources/users/v1/{id}
https://api.ca.frontegg.com/identity/resources/users/v1/{id}
https://api.au.frontegg.com/identity/resources/users/v1/{id}
https://app-xxx.frontegg.com/identity/resources/users/v1/{id}
curl -i -X GET \
'https://api.frontegg.com/identity/resources/users/v1/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'frontegg-tenant-id: string'{ "id": "string", "email": "string", "name": "string", "profilePictureUrl": "string", "sub": "string", "verified": true, "mfaEnrolled": true, "mfaBypass": true, "phoneNumber": "string", "roles": [ { … } ], "permissions": [ { … } ], "provider": "string", "tenantId": "string", "tenantIds": [ "string" ], "activatedForTenant": true, "isLocked": true, "tenants": [ { … } ], "invisible": true, "superUser": true, "metadata": "string", "vendorMetadata": "string", "createdAt": "2019-08-24T14:15:22Z", "lastLogin": "2019-08-24T14:15:22Z", "groups": [ {} ], "subAccountAccessAllowed": true, "managedBy": "frontegg" }
https://api.frontegg.com/identity/resources/users/v1/{userId}/verify
https://api.us.frontegg.com/identity/resources/users/v1/{userId}/verify
https://api.ca.frontegg.com/identity/resources/users/v1/{userId}/verify
https://api.au.frontegg.com/identity/resources/users/v1/{userId}/verify
https://app-xxx.frontegg.com/identity/resources/users/v1/{userId}/verify
curl -i -X POST \
'https://api.frontegg.com/identity/resources/users/v1/{userId}/verify' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Set whether a user is invisible or visible.
An invisible user remains part of the account (tenant) but will not appear in the list of users in the admin box. The user data remains in the system.
Provide the user's ID as a path parameter and a Boolean invisible value in the request body (true for invisible, false for visible).
A valid environment token is required to call this endpoint. You can obtain it from the environment authentication route.
https://api.frontegg.com/identity/resources/users/v1/{userId}/invisible
https://api.us.frontegg.com/identity/resources/users/v1/{userId}/invisible
https://api.ca.frontegg.com/identity/resources/users/v1/{userId}/invisible
https://api.au.frontegg.com/identity/resources/users/v1/{userId}/invisible
https://app-xxx.frontegg.com/identity/resources/users/v1/{userId}/invisible
curl -i -X PUT \
'https://api.frontegg.com/identity/resources/users/v1/{userId}/invisible' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"invisible": true
}'{ "id": "string", "email": "string", "name": "string", "profilePictureUrl": "string", "sub": "string", "verified": true, "mfaEnrolled": true, "mfaBypass": true, "phoneNumber": "string", "roles": [ { … } ], "permissions": [ { … } ], "provider": "string", "tenantId": "string", "tenantIds": [ "string" ], "activatedForTenant": true, "isLocked": true, "tenants": [ { … } ], "invisible": true, "superUser": true, "metadata": "string", "vendorMetadata": "string", "createdAt": "2019-08-24T14:15:22Z", "lastLogin": "2019-08-24T14:15:22Z", "groups": [ {} ], "subAccountAccessAllowed": true, "managedBy": "frontegg" }