This option is exclusively available in our GROW and PRO plans.
This guide outlines the two options for integrating your user database with our system: a one-time import of user data or setting up an ongoing integration using OAuth2.0 or OpenID Connect. Choose the option that best fits your needs.
Option 1: User Data Import
For a one-time import of your user database into ours, follow these steps:
Create a Test User: Generate a test user in your database.
Export Database Row: Provide the database row for the test user, including the column names.
Send User Details: Share the test user's username, password, and hashing algorithm (if known).
Example Database Dump:
SET SQL_MODE = "NO_AUTO_VALUE_ON_ZERO";
START TRANSACTION;
SET time_zone = "+00:00";
CREATE TABLE `be_users` (
`id` int(10) UNSIGNED NOT NULL,
`first_name` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
`last_name` varchar(255) COLLATE utf8_unicode_ci DEFAULT NULL,
`username` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
`email` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
`password` varchar(60) COLLATE utf8_unicode_ci NOT NULL,
`gender` enum('M','F') COLLATE utf8_unicode_ci NOT NULL,
`birthday` datetime DEFAULT NULL,
`accept_notifications` tinyint(1) DEFAULT NULL,
`accept_sharing` tinyint(1) DEFAULT NULL,
`accept_personal_data` tinyint(1) DEFAULT NULL,
`remember_token` varchar(100) COLLATE utf8_unicode_ci DEFAULT NULL,
`is_logged` tinyint(1) NOT NULL DEFAULT '0',
`created_at` timestamp NULL DEFAULT NULL,
`updated_at` timestamp NULL DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
INSERT INTO `be_users` (`id`, `first_name`, `last_name`, `username`, `email`, `password`, `gender`, `birthday`, `accept_notifications`, `accept_sharing`, `accept_personal_data`, `remember_token`, `is_logged`, `created_at`, `updated_at`) VALUES
(28774, NULL, NULL, 'testuser-bal', '[email protected]', '$2y$10$fKm6UoynjcE3cDoM5oVm3.WHXWTIv5hhyohExw2t83pOGqCUXU', NULL, NULL, NULL, NULL, NULL, NULL, '0', NULL, NULL);
ALTER TABLE `be_users`
ADD PRIMARY KEY (`id`),
ADD UNIQUE KEY `be_users_username_unique` (`username`),
ADD UNIQUE KEY `be_users_email_unique` (`email`);
ALTER TABLE `be_users`
MODIFY `id` int(10) UNSIGNED NOT NULL AUTO_INCREMENT, AUTO_INCREMENT=28776;
COMMIT;
Important Details:
Column Names: Provide all column names to ensure proper mapping of user data.
Password Hashing: Specify the password hashing algorithm (e.g., bcrypt) for accurate password management.
Option 2: User Database Integration
For ongoing synchronization and authentication, set up an integration using OAuth2.0 or OpenID Connect:
Backend System: Provide details about your current backend system.
Authentication Handling: Describe how authentication is managed.
Protocol Support: Indicate if your system supports OAuth2.0 or OpenID Connect.
API Endpoints: Confirm if you can add or implement additional API endpoints if necessary.
Database Access: State if you have direct access to the database.
Database Type: Identify the type of database used.
Questions to Answer:
What backend system are you using?
How is authentication handled?
Does your system support OAuth2.0 or OpenID Connect?
Can additional API endpoints be implemented if needed?
Do you have direct database access?
What type of database is used?
Summary
Choose between importing user data for a one-time migration or integrating your user database for ongoing synchronization. Provide the necessary details for each option to ensure a smooth setup.
Action Points:
For Import: Prepare and share the test user data and database schema.
For Integration: Provide information about your authentication system and database setup.