This repository includes a Python utility for migrating from a third-party service to Descope.
This currently tool supports the following third-party services:
- Auth0
- AWS Cognito
- Firebase
Migrations can differ wildly depending on the specific identity implementation and provider. However, this tool serves as a template that you can edit if it doesn't fully meet your needs.
- Clone the Repo:
git clone git@github.com:descope/descope-migration.git
- Create a Virtual Environment
python3 -m venv venv
source venv/bin/activate
- Install the Necessary Python libraries
pip3 install -r requirements.txt
- Follow the guide for your specfic third-party
- Auth0
- AWS Cognito
- Firebase
- If you're using a Custom data store please follow this guide instead Custom Data Store
The tool will handle migrations differently for each third-party service. However, there are some general commands that remain consistent across all third parties.
To pick the the Third-Party service to migrate from you must pass the provider flag
The following are supported:
auth0for Auth0 by Oktacognitofor AWS Cognitofirebasefor Firebase
Use:
python3 src/main.py auth0
Pick the third-party you are migrating from and follow the corrosponding guide
If you want to see what users and other information will be migrated before actually migrating you can dry run the migration for all thrid-parties. Live run will actually perform the migration
The --dry-run flag can be used by all third-parties:
python3 src/main.py provider --dry-run
To live run exclude the --dry-run flag:
python3 src/main.py provider
You can add the -v or --verbose flag to any dry run or live run by any provider to get more information on which users or objects are being migrated.
Exclude the flag to get a more compact printout.
Use:
Dry Run Verbose: python3 src/main.py --dry-run -v
Live Run Verbose: python3 src/main.py -v
For any issues or suggestions, feel free to open an issue in the GitHub repository.
This project is licensed under the MIT License - see the LICENSE file for details.