FRfrontegg
Data migration

Migrate a vendor user

This route enables you to migrate a user by sending the following required fields: user’s email, their tenantId and metadata, a new user will be created. This endpoint takes other properties as well, such as the user’s name, their phone number, hashed password, etc...

post/resources/migrations/v1/local

Request

Request body

passwordHashstring

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

passwordHashType'bcrypt' | 'scrypt' | 'firebase-scrypt' | 'pbkdf2' | 'argon2'
passwordHashConfigstring

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 }

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

provider'local' | 'saml' | 'google' | 'github' | 'facebook' | 'microsoft' | 'scim2' | 'slack' | 'apple'
metadatastring

Stringified JSON object

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

roleIdsstring[]

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

emailstring required
tenantIdstring required
namestring
profilePictureUrlstring
authenticatorAppMfaSecretstring

Response

idstring required
emailstring required
namestring
profilePictureUrlstring
substring required
verifiedboolean required
mfaEnrolledboolean required
mfaBypassboolean
phoneNumberstring
providerstring required
tenantIdstring required
tenantIdsstring[] required
activatedForTenantboolean
isLockedboolean
invisibleboolean
superUserboolean
metadatastring required
vendorMetadatastring required
createdAtstring date-time required
lastLoginstring date-time required
groupsobject[]
subAccountAccessAllowedboolean required
managedBy'frontegg' | 'scim2' | 'external'

Changes

No recorded changes to this operation across all 1 revision of this API.