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

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

Get roles v2

Request

This route returns all roles for vendor. Each role is an object containing the name, permissions, and other defining information.

Query
_limitnumber[ 1 .. 2000 ]
Default 50
_sortBystringrequired
Enum"key""name""description""isDefault""firstUserRole""level""updatedAt""createdAt""permissions""userTenants"
_levelsArray of numbers
_tenantIdsArray of strings
_offsetnumber>= 0
Default 0
_orderstring
Enum"ASC""DESC"
_filterstring
Headers
frontegg-tenant-idstring

For relating a role to a specific tenant, use get tenants API to find the tenant ids

curl -i -X GET \
  'https://api.frontegg.com/identity/resources/roles/v2?_sortBy=key' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstringrequired
vendorIdstringrequired
tenantIdstringrequired
keystringrequired
namestringrequired
descriptionstringrequired
isDefaultbooleanrequired
firstUserRolebooleanrequired
levelnumberrequired
createdAtstring(date-time)required
updatedAtstring(date-time)required
permissionsArray of stringsrequired
Response
application/json
{ "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" ] }

Create a new role

Request

This route adds a new role for a specific tenant. Send the tenant ID in the frontegg-tenant-id header. Add the required permissions within the request body to customize the role.

Headers
frontegg-tenant-idstring

For relating a role to a specific tenant, use get tenants API to find the tenant ids

Bodyapplication/jsonrequired
keystringrequired
namestringrequired
descriptionstring
isDefaultboolean

This role will be assigned for every user that will be added without specified roles

baseRoleIdstringrequired

Role level of the new role will be based on this parameter

permissionIdsArray of stringsrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/roles/v2 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "string",
    "name": "string",
    "description": "string",
    "isDefault": true,
    "baseRoleId": "string",
    "permissionIds": [
      "string"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired
vendorIdstringrequired
tenantIdstringrequired
keystringrequired
namestringrequired
descriptionstringrequired
isDefaultbooleanrequired
permissionsArray of stringsrequired
Response
application/json
{ "id": "string", "vendorId": "string", "tenantId": "string", "key": "string", "name": "string", "description": "string", "isDefault": true, "permissions": [ "string" ] }

Get distinct levels of roles

Request

This route returns all levels from roles for vendor.

Headers
frontegg-tenant-idstring

For relating a role to a specific tenant, use get tenants API to find the tenant ids

curl -i -X GET \
  https://api.frontegg.com/identity/resources/roles/v2/distinct-levels \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Get distinct assigned tenants of roles

Request

This route returns all assigned tenant ids from roles for vendor.

Headers
frontegg-tenant-idstring

For relating a role to a specific tenant, use get tenants API to find the tenant ids

curl -i -X GET \
  https://api.frontegg.com/identity/resources/roles/v2/distinct-tenants \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

API tokens

Operations

Domain restrictions

Operations

IP restrictions

Operations

Lockout policy

Operations

Password settings

Operations

Personal tokens

Operations

Sessions management

Operations

User groups

Operations

User management

Operations

User sessions

Operations

Users-applications management

Operations