Users, auth and security module
/
SMS
/
Pre-verify user's phone number

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.

Download OpenAPI description
Users, Auth and Security
Single Sign-On
SCIM Provisioning
Entitlements
Entitlements Agent
Accounts (Tenants)
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

Get all phone numbers

Request

This route returns all user phone numbers.

Query
_limitnumber>= 1
_offsetnumber>= 0
_sortBystring
Enum"userId""phoneNumber"
_orderstring
Enum"ASC""DESC"
_phoneNumberstring
curl -i -X GET \
  https://api.frontegg.com/identity/resources/users/phone-numbers/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

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

Set phone number for a user

Request

This route creates new user phone number. By default verification code will be sent to the user. To create phone number without verification code, send verify as part of the request with value false.

Bodyapplication/jsonrequired
phoneNumberstringrequired

New phone number

verifyboolean

Should send verification code, default is true

Default true
curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/phone-numbers/v1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "phoneNumber": "string",
    "verify": true
  }'

Responses

Bodyapplication/json
object(UserPhoneNumberCreatedResponseDto)
Response
application/json
{}

Pre-verify user's phone number

Request

This route sends OTC to users phone number for verification.

Bodyapplication/jsonrequired
phoneNumberstringrequired

New phone number

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/phone-numbers/v1/preverify \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "phoneNumber": "string"
  }'

Responses

Bodyapplication/json
object(UserPhoneNumberCreatedResponseDto)
Response
application/json
{}

Verify creation of phone number for user

Request

This route verifies user phone number using OTC code that was sent to the user.

Bodyapplication/jsonrequired
otcTokenstringrequired

OTC token

codestringrequired

Code that was sent to the user

curl -i -X POST \
  https://api.frontegg.com/identity/resources/users/phone-numbers/v1/verify \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "otcToken": "string",
    "code": "string"
  }'

Responses

Delete user's phone number

Request

This route starts delete process for user phone number. Verification code will be sent to the user. Phone number wont be deleted until delete verification.

Path
idstringrequired
curl -i -X DELETE \
  'https://api.frontegg.com/identity/resources/users/phone-numbers/v1/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
object(UserPhoneNumberDeleteCodeResponseDto)
Response
application/json
{}

Verify delete user's phone number

Request

This route verifies delete of user phone number using OTC code that was sent to the user and deletes phone number.

Path
idstringrequired
Bodyapplication/jsonrequired
otcTokenstringrequired

OTC token

codestringrequired

Code that was sent to the user

curl -i -X POST \
  'https://api.frontegg.com/identity/resources/users/phone-numbers/v1/{id}/delete/verify' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "otcToken": "string",
    "code": "string"
  }'

Responses

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