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

Reset password via SMS

Request

This route sends a reset password SMS to the user. Send an OTC to the user’s phone number in the POST body.

Bodyapplication/jsonrequired
identifierstringrequired

User identifier (phone number or email)

identifierTypestringrequired

Type of the identifier

Enum"email""phoneNumber""username"
emailMetadataobject
curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v2/passwords/reset/sms \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "identifier": "string",
    "identifierType": "email",
    "emailMetadata": {}
  }'

Responses

Bodyapplication/json
sessionIdstringrequired
Response
application/json
{ "sessionId": "string" }

Verify password reset code sent via SMS

Request

This route verifies the OTC sent via SMS for the password reset process. Gets the OTC from the POST body and returns userId and reset token if valid.

Bodyapplication/jsonrequired
otcTokenstringrequired
sessionIdstringrequired
curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/v2/passwords/reset/sms/verify \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "otcToken": "string",
    "sessionId": "string"
  }'

Responses

Bodyapplication/json
userIdstringrequired
tokenstringrequired
Response
application/json
{ "userId": "string", "token": "string" }

Get password expiration period configuration

Request

Retrieve the password expiration period configuration for your environment or for a specific account (tenant).

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

Responses

Bodyapplication/json
createdAtstring(date-time)required
updatedAtstring(date-time)required
isActivebooleanrequired
rotationPeriodnumberrequired
notificationPeriodnumberrequired
tenantIdstringrequired
Response
application/json
{ "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "isActive": true, "rotationPeriod": 0, "notificationPeriod": 0, "tenantId": "string" }

Personal tokens

Operations

Sessions management

Operations

User groups

Operations

User management

Operations

User sessions

Operations

Users-applications management

Operations