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

Get permissions categories

Request

This route returns all permissions categories for a vendor. Each category is an object containing the name, description, permissions, and other defining information.

curl -i -X GET \
  https://api.frontegg.com/identity/resources/permissions/v1/categories \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
idstringrequired
namestringrequired
descriptionstring or nullrequired
createdAtstring(date-time)required
feCategorybooleanrequired
]
Response
application/json
[ { "id": "string", "name": "string", "description": "string", "createdAt": "2019-08-24T14:15:22Z", "feCategory": true } ]

Create category

Request

Use this route to add a new permissions category. Each category you add requires you to send information about the category in the POST body. Note that you do not associate the category with permissions here. You do that using the add and update permission routes where you send the category ID as a body parameter.

Bodyapplication/jsonrequired
namestringrequired
descriptionstring
idstring
curl -i -X POST \
  https://api.frontegg.com/identity/resources/permissions/v1/categories \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "id": "string"
  }'

Responses

Bodyapplication/json
idstringrequired
namestringrequired
descriptionstring or nullrequired
createdAtstring(date-time)required
feCategorybooleanrequired
Response
application/json
{ "id": "string", "name": "string", "description": "string", "createdAt": "2019-08-24T14:15:22Z", "feCategory": true }

Update category

Request

This route updates an existing permissions category. Add the category ID as a path parameter to the route url to specify which category you are updating. Send the updated information about the category in the PATCH body. Note that here is not where you update the permissions associated with the category. Use the add or update permissions routes to do that. Use the Get categories API to get

Path
categoryIdstringrequired
Bodyapplication/jsonrequired
namestring
descriptionstring
curl -i -X PATCH \
  'https://api.frontegg.com/identity/resources/permissions/v1/categories/{categoryId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string"
  }'

Responses

Delete category

Request

This route deletes a category. Add the category ID as a path parameter to the route url to specify which category you are deleting. Use the Get categories API to get the category ID.

Path
categoryIdstringrequired
curl -i -X DELETE \
  'https://api.frontegg.com/identity/resources/permissions/v1/categories/{categoryId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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