Skip to content

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

Get all JWT templates

Request

Retrieves all JWT templates for your environment. Note: This feature must be enabled by request.

Security
bearer
Query
keysArray of strings

Filter by template keys

idsArray of strings

Filter by template IDs

_limitnumber>= 1

Maximum number of items to return

_offsetnumber>= 0

The page number to retrieve. For example, use 0 for the first page, 1 for the second page.

_sortBystring

Field to sort by

Enum"id""key""name""createdAt""updatedAt"
_orderstring

Sort order

Enum"ASC""DESC"
curl -i -X GET \
  https://api.frontegg.com/identity/resources/jwt-templates/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
itemsArray of objects(JwtTemplateResponseDto)
_linksobject(FronteggPaginationLinks)
_metadataobject(FronteggPaginationMetadata)
Response
application/json
{ "items": [ { … } ], "_links": { "next": "string", "prev": "string", "first": "string", "last": "string" }, "_metadata": { "totalItems": 0, "totalPages": 0 } }

Get JWT template by ID

Request

Retrieves a specific JWT template by ID. Note: This feature must be enabled by request.

Security
bearer
Path
idstringrequired
curl -i -X GET \
  'https://api.frontegg.com/identity/resources/jwt-templates/v1/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
idstringrequired

Template ID

vendorIdstringrequired

Vendor ID

keystringrequired

Unique key for the template

namestringrequired

Name of the template

descriptionstring or null

Description of the template

expirationnumberrequired

Token expiration time in seconds

algorithmstringrequired

JWT signing algorithm

Enum"RS256""HS256"
templateSchemaobjectrequired
templateSchema.​claimsobjectrequired

Claims mapping as key-value pairs

createdAtstring(date-time)required

Creation timestamp

updatedAtstring(date-time)required

Last update timestamp

Response
application/json
{ "id": "string", "vendorId": "string", "key": "string", "name": "string", "description": "string", "expiration": 0, "algorithm": "RS256", "templateSchema": { "claims": {} }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

Update JWT template

Request

Updates an existing JWT template. Note: This feature must be enabled by request.

Security
bearer
Path
idstringrequired
Bodyapplication/jsonrequired
keystring

Unique key for the template

namestring

Name of the template

descriptionstring

Description of the template

expirationnumber[ 10 .. 15552000 ]

Token expiration time in seconds

algorithmstring

JWT signing algorithm

Enum"RS256""HS256"
templateSchemaobject
curl -i -X PUT \
  'https://api.frontegg.com/identity/resources/jwt-templates/v1/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "key": "string",
    "name": "string",
    "description": "string",
    "expiration": 10,
    "algorithm": "RS256",
    "templateSchema": {
      "claims": {}
    }
  }'

Responses

Bodyapplication/json
idstringrequired

Template ID

vendorIdstringrequired

Vendor ID

keystringrequired

Unique key for the template

namestringrequired

Name of the template

descriptionstring or null

Description of the template

expirationnumberrequired

Token expiration time in seconds

algorithmstringrequired

JWT signing algorithm

Enum"RS256""HS256"
templateSchemaobjectrequired
templateSchema.​claimsobjectrequired

Claims mapping as key-value pairs

createdAtstring(date-time)required

Creation timestamp

updatedAtstring(date-time)required

Last update timestamp

Response
application/json
{ "id": "string", "vendorId": "string", "key": "string", "name": "string", "description": "string", "expiration": 0, "algorithm": "RS256", "templateSchema": { "claims": {} }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }

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

API tokens

Operations

Domain restrictions

Operations

IP restrictions

Operations

Lockout policy

Operations

MFA settings

Operations

Password settings

Operations

Personal tokens

Operations

Sessions management

Operations

User groups

Operations

User management

Operations

User sessions

Operations

Users-applications management

Operations