Skip to content
/Data migration

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

Account invitations settings

Operations

Core settings

Operations

Custom social OAuth provider

Operations

Data migration

Operations

Migrate from Auth0

Request

Migrate users from Auth0 into your environment.

Provide the domain, clientId, secret, and tenantIdFieldName parameters in the request body. These values can be obtained from your Auth0 account (tenant) configuration.

Security
bearer
Bodyapplication/jsonrequired
domainstringrequired
clientIdstringrequired
secretstringrequired
tenantIdFieldNamestringrequired

The field name that the tenant ID will be taken from under app metadata

isTenantIdOnUserMetadataboolean

If you would like to take tenant ID from user metadata, set this field to true

curl -i -X POST \
  https://api.frontegg.com/identity/resources/migrations/v1/auth0 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "domain": "string",
    "clientId": "string",
    "secret": "string",
    "tenantIdFieldName": "string",
    "isTenantIdOnUserMetadata": true
  }'

Responses

Migrate a single user

Request

Migrate a user into your environment.

Provide the required fields: user's email, tenantId, and metadata. You can also include additional properties such as the user's name, phone number, hashed password, and other optional attributes.

Security
bearer
Bodyapplication/jsonrequired
tenantIdstringrequired

The tenant id of the user

namestring

The name of the user

profilePictureUrlstring<= 4095 characters

The profile picture url of the user

passwordHashstring

The password hash. For SCrypt should include the salt and key seperated by the salt separator

passwordHashTypestring(PasswordHashingType)
Enum"bcrypt""scrypt""firebase-scrypt""pbkdf2""argon2""sha256""sha1"
passwordHashConfigstring<= 4095 characters

Stringified JSON Hashing config for the migrated password. For SCrypt should be formatted as { saltSeparator, N, r, p, keyLen }. For FirebaseScrypt should be formatted as { memCost, rounds, saltSeparator, signerKey }

authenticatorAppMfaSecretstring

The authenticator app MFA secret

phoneNumberstring

phoneNumber can be used both for login with SMS and for MFA This auto-enrolls the user in MFA, prompting them at first login (regardless of tenant/vendor MFA settings). The required format is an area code + number, no spaces. For example: "+16037184056" The number must be unique

phoneNumberTypestring(PhoneNumberType)
Enum"auth""mfa"
providerstring
Default "local"
Enum"local""saml""google""github""facebook""microsoft""scim2""slack""apple"
metadatastring

Stringified JSON object

roleIdsArray of strings

Role ids of the migrated users. If not provided, the user will be assigned the default roles

Default []
vendorMetadatastring

Extra vendor-only data. stringified JSON object

externalIdstring

The external id of the user

usernamestring<= 128 characters

The username of the user. If not provided, the email is required. Maximum length is 255 characters.

emailstringrequired

The email of the user. If not provided, the username is required

verifyUserboolean

Whether to verify the user as part of the migration process. If this is set to false, another call is required for the verify user API

Default false
curl -i -X POST \
  https://api.frontegg.com/identity/resources/migrations/v1/local \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "tenantId": "string",
    "name": "string",
    "profilePictureUrl": "string",
    "passwordHash": "string",
    "passwordHashType": "bcrypt",
    "passwordHashConfig": "string",
    "authenticatorAppMfaSecret": "string",
    "phoneNumber": "string",
    "phoneNumberType": "auth",
    "provider": "local",
    "metadata": "string",
    "roleIds": [],
    "vendorMetadata": "string",
    "externalId": "string",
    "username": "string",
    "email": "string",
    "verifyUser": false
  }'

Responses

Bodyapplication/json
idstringrequired
emailstringrequired
namestringrequired
profilePictureUrlstringrequired
substringrequired
verifiedbooleanrequired
mfaEnrolledbooleanrequired
mfaBypassboolean
phoneNumberstring
rolesArray of objects(RoleResponse)required
roles[].​idstringrequired
roles[].​vendorIdstringrequired
roles[].​tenantIdstringrequired
roles[].​keystringrequired
roles[].​namestringrequired
roles[].​descriptionstringrequired
roles[].​isDefaultbooleanrequired
roles[].​firstUserRolebooleanrequired
roles[].​levelnumberrequired
roles[].​createdAtstring(date-time)required
roles[].​updatedAtstring(date-time)required
roles[].​permissionsArray of stringsrequired
permissionsArray of objects(PermissionResponse)required
permissions[].​idstringrequired
permissions[].​keystringrequired
permissions[].​namestringrequired
permissions[].​descriptionstringrequired
permissions[].​createdAtstring(date-time)required
permissions[].​updatedAtstring(date-time)required
permissions[].​roleIdsArray of stringsrequired
permissions[].​categoryIdstringrequired
permissions[].​fePermissionbooleanrequired
providerstringrequired
tenantIdstringrequired
tenantIdsArray of stringsrequired
activatedForTenantboolean
isLockedboolean
tenantsArray of objects(UserTenantDto)required
tenants[].​tenantIdstringrequired
tenants[].​rolesArray of objects(RoleResponse)required
tenants[].​roles[].​idstringrequired
tenants[].​roles[].​vendorIdstringrequired
tenants[].​roles[].​tenantIdstringrequired
tenants[].​roles[].​keystringrequired
tenants[].​roles[].​namestringrequired
tenants[].​roles[].​descriptionstringrequired
tenants[].​roles[].​isDefaultbooleanrequired
tenants[].​roles[].​firstUserRolebooleanrequired
tenants[].​roles[].​levelnumberrequired
tenants[].​roles[].​createdAtstring(date-time)required
tenants[].​roles[].​updatedAtstring(date-time)required
tenants[].​roles[].​permissionsArray of stringsrequired
tenants[].​temporaryExpirationDatestring(date-time)
tenants[].​isDisabledboolean
invisibleboolean
superUserboolean
metadatastringrequired
vendorMetadatastringrequired
externalIdstring
createdAtstring(date-time)required
lastLoginstring(date-time)required
groupsArray of objects
subAccountAccessAllowedbooleanrequired
managedBystring
Enum"frontegg""scim2""external"
Response
application/json
{
  "id": "string",
  "email": "string",
  "name": "string",
  "profilePictureUrl": "string",
  "sub": "string",
  "verified": true,
  "mfaEnrolled": true,
  "mfaBypass": true,
  "phoneNumber": "string",
  "roles": [
    { … }
  ],
  "permissions": [
    { … }
  ],
  "provider": "string",
  "tenantId": "string",
  "tenantIds": [
    "string"
  ],
  "activatedForTenant": true,
  "isLocked": true,
  "tenants": [
    { … }
  ],
  "invisible": true,
  "superUser": true,
  "metadata": "string",
  "vendorMetadata": "string",
  "externalId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "lastLogin": "2019-08-24T14:15:22Z",
  "groups": [
    {}
  ],
  "subAccountAccessAllowed": true,
  "managedBy": "frontegg"
}

Migrate users in bulk

Request

Migrate users in bulk into your environment.

Provide an array of users in the request body. Each user object must include the user's email and tenantId, which specifies the user's parent account. You can include additional fields as needed to store more information. If you need to store custom data, use the metadata property.

Security
bearer
Bodyapplication/jsonrequired
usersArray of objects(MigrateUserRequestV1)required
users[].​tenantIdstringrequired

The tenant id of the user

users[].​namestring

The name of the user

users[].​profilePictureUrlstring<= 4095 characters

The profile picture url of the user

users[].​passwordHashstring

The password hash. For SCrypt should include the salt and key seperated by the salt separator

users[].​passwordHashTypestring(PasswordHashingType)
Enum"bcrypt""scrypt""firebase-scrypt""pbkdf2""argon2""sha256""sha1"
users[].​passwordHashConfigstring<= 4095 characters

Stringified JSON Hashing config for the migrated password. For SCrypt should be formatted as { saltSeparator, N, r, p, keyLen }. For FirebaseScrypt should be formatted as { memCost, rounds, saltSeparator, signerKey }

users[].​authenticatorAppMfaSecretstring

The authenticator app MFA secret

users[].​phoneNumberstring

phoneNumber can be used both for login with SMS and for MFA This auto-enrolls the user in MFA, prompting them at first login (regardless of tenant/vendor MFA settings). The required format is an area code + number, no spaces. For example: "+16037184056" The number must be unique

users[].​phoneNumberTypestring(PhoneNumberType)
Enum"auth""mfa"
users[].​providerstring
Default "local"
Enum"local""saml""google""github""facebook""microsoft""scim2""slack""apple"
users[].​metadatastring

Stringified JSON object

users[].​roleIdsArray of strings

Role ids of the migrated users. If not provided, the user will be assigned the default roles

Default []
users[].​vendorMetadatastring

Extra vendor-only data. stringified JSON object

users[].​externalIdstring

The external id of the user

users[].​usernamestring<= 128 characters

The username of the user. If not provided, the email is required. Maximum length is 255 characters.

users[].​emailstringrequired

The email of the user. If not provided, the username is required

users[].​verifyUserboolean

Whether to verify the user as part of the migration process. If this is set to false, another call is required for the verify user API

Default false
curl -i -X POST \
  https://api.frontegg.com/identity/resources/migrations/v1/local/bulk \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "users": [
      {
        "tenantId": "string",
        "name": "string",
        "profilePictureUrl": "string",
        "passwordHash": "string",
        "passwordHashType": "bcrypt",
        "passwordHashConfig": "string",
        "authenticatorAppMfaSecret": "string",
        "phoneNumber": "string",
        "phoneNumberType": "auth",
        "provider": "local",
        "metadata": "string",
        "roleIds": [],
        "vendorMetadata": "string",
        "externalId": "string",
        "username": "string",
        "email": "string",
        "verifyUser": false
      }
    ]
  }'

Responses

Bodyapplication/json
migrationIdstringrequired
Response
application/json
{
  "migrationId": "string"
}

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