The tenant id of the user
//
- Migrate vendor users in bulk
Migrate from Auth0
Migrate a single user
Migrate users in bulk
Check status of bulk migration
Migrate vendor users in b...
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
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/
- EU Regionhttps://api.frontegg.com/identity/resources/migrations/v1/local/bulk/status/{migrationId}
- US Regionhttps://api.us.frontegg.com/identity/resources/migrations/v1/local/bulk/status/{migrationId}
- CA Regionhttps://api.ca.frontegg.com/identity/resources/migrations/v1/local/bulk/status/{migrationId}
- AU Regionhttps://api.au.frontegg.com/identity/resources/migrations/v1/local/bulk/status/{migrationId}
- Frontegg sub-domain for use with user tokenshttps://app-xxx.frontegg.com/identity/resources/migrations/v1/local/bulk/status/{migrationId}
- cURL
- JavaScript
- Python
- GO
- Payload
curl -i -X GET \
'https://api.frontegg.com/identity/resources/migrations/v1/local/bulk/status/{migrationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Bodyapplication/jsonrequired
The password hash. For SCrypt should include the salt and key seperated by the salt separator
Enum"bcrypt""scrypt""firebase-scrypt""pbkdf2""argon2""sha256""sha1"
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 }
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
Default "local"
Enum"local""saml""google""github""facebook""microsoft""scim2""slack""apple"
Role ids of the migrated users. If not provided, the user will be assigned the default roles
Default []
The username of the user. If not provided, the email is required. Maximum length is 128 characters.
- EU Regionhttps://api.frontegg.com/identity/resources/migrations/v2/local/bulk
- US Regionhttps://api.us.frontegg.com/identity/resources/migrations/v2/local/bulk
- CA Regionhttps://api.ca.frontegg.com/identity/resources/migrations/v2/local/bulk
- AU Regionhttps://api.au.frontegg.com/identity/resources/migrations/v2/local/bulk
- Frontegg sub-domain for use with user tokenshttps://app-xxx.frontegg.com/identity/resources/migrations/v2/local/bulk
- cURL
- JavaScript
- Python
- GO
- Payload
curl -i -X POST \
https://api.frontegg.com/identity/resources/migrations/v2/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",
"emails": [
{
"email": "user@example.com",
"primary": true,
"verified": true
}
]
}
]
}'Response
application/json
{ "migrationId": "string" }