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/roles/v1/{roleId}
https://api.us.frontegg.com/identity/resources/roles/v1/{roleId}
https://api.ca.frontegg.com/identity/resources/roles/v1/{roleId}
https://api.au.frontegg.com/identity/resources/roles/v1/{roleId}
https://app-xxx.frontegg.com/identity/resources/roles/v1/{roleId}
curl -i -X DELETE \
'https://api.frontegg.com/identity/resources/roles/v1/{roleId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Update an existing role.
Provide the role ID as a path parameter to specify which role to update, and send the updated role information in the request body.
This route does not update permissions for the role. Use the attach permissions to role route to manage role permissions.
You can obtain the role ID using the Get roles API.
This role will be assigned for every user that will be added without specified roles
Set this property to true together with isDefault in order to assign this role to all users
https://api.frontegg.com/identity/resources/roles/v1/{roleId}
https://api.us.frontegg.com/identity/resources/roles/v1/{roleId}
https://api.ca.frontegg.com/identity/resources/roles/v1/{roleId}
https://api.au.frontegg.com/identity/resources/roles/v1/{roleId}
https://app-xxx.frontegg.com/identity/resources/roles/v1/{roleId}
curl -i -X PATCH \
'https://api.frontegg.com/identity/resources/roles/v1/{roleId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"isDefault": true,
"firstUserRole": true,
"migrateRole": true,
"level": 32767,
"key": "string",
"name": "string",
"description": "string"
}'{ "id": "string", "vendorId": "string", "tenantId": "string", "key": "string", "name": "string", "description": "string", "isDefault": true, "firstUserRole": true, "level": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "permissions": [ "string" ] }
Assign permissions to a role.
Provide the role ID as a path parameter and include the permission IDs in the request body as an array of strings. Any pre-existing permissions will be overridden by the new permissions.
You can obtain role IDs using the Get roles API and permission IDs using the Get permissions API.
https://api.frontegg.com/identity/resources/roles/v1/{roleId}/permissions
https://api.us.frontegg.com/identity/resources/roles/v1/{roleId}/permissions
https://api.ca.frontegg.com/identity/resources/roles/v1/{roleId}/permissions
https://api.au.frontegg.com/identity/resources/roles/v1/{roleId}/permissions
https://app-xxx.frontegg.com/identity/resources/roles/v1/{roleId}/permissions
curl -i -X PUT \
'https://api.frontegg.com/identity/resources/roles/v1/{roleId}/permissions' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"permissionIds": [
"string"
]
}'{ "id": "string", "vendorId": "string", "tenantId": "string", "key": "string", "name": "string", "description": "string", "isDefault": true, "firstUserRole": true, "level": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "permissions": [ "string" ] }