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

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

Get users for application

Request

This route gets users for an application.

Path
appIdstringrequired
curl -i -X GET \
  'https://api.frontegg.com/identity/resources/applications/v1/{appId}/users' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
string
]
Response
application/json
[ "string" ]

Get applications for user

Request

This route gets applications for a user.

Path
userIdstringrequired
curl -i -X GET \
  'https://api.frontegg.com/identity/resources/applications/v1/{userId}/apps' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/jsonArray [
string
]
Response
application/json
[ "string" ]

Assign users to application

Request

This route assigns users to an application.

Bodyapplication/jsonrequired
appIdstringrequired
tenantIdstringrequired
userIdsArray of stringsrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/applications/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appId": "string",
    "tenantId": "string",
    "userIds": [
      "string"
    ]
  }'

Responses

Bodyapplication/jsonArray [
appIdstringrequired
userTenantIdstringrequired
createdAtstring(date-time)required
]
Response
application/json
[ { "appId": "string", "userTenantId": "string", "createdAt": "2019-08-24T14:15:22Z" } ]

Unassign users from application

Request

This route unassigns users from an application.

Bodyapplication/jsonrequired
appIdstringrequired
tenantIdstringrequired
userIdsArray of stringsrequired
curl -i -X DELETE \
  https://api.frontegg.com/identity/resources/applications/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appId": "string",
    "tenantId": "string",
    "userIds": [
      "string"
    ]
  }'

Responses

Get user active tenants in applications

Request

This route gets the active user tenants for an application.

Headers
frontegg-user-idstringrequired

The user ID identifier

curl -i -X GET \
  https://api.frontegg.com/identity/resources/applications/user-tenants/active/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'frontegg-user-id: string'

Responses

Bodyapplication/json
applicationActiveTenantsArray of objects(UserApplicationActiveTenantResponse)required
applicationActiveTenants[].​tenantIdstringrequired
applicationActiveTenants[].​applicationIdstringrequired
Response
application/json
{ "applicationActiveTenants": [ {} ] }

Switch users active tenant in applications

Request

This route updates the active user tenants for an application.

Headers
frontegg-user-idstringrequired

The user ID identifier

Bodyapplication/jsonrequired
activeApplicationTenantsArray of objects(SwitchApplicationActiveUserTenantDto)required

List of applications and tenants to set as active, for user

activeApplicationTenants[].​applicationIdstringrequired

Desired application to set active tenant in

activeApplicationTenants[].​tenantIdstringrequired

Desired tenant to set as active tenant for user in application

curl -i -X PUT \
  https://api.frontegg.com/identity/resources/applications/user-tenants/active/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'frontegg-user-id: string' \
  -d '{
    "activeApplicationTenants": [
      {
        "applicationId": "string",
        "tenantId": "string"
      }
    ]
  }'

Responses