Easily export your Stormpath user data.
Easily export your Stormpath user data.
Stormpath is one of my favorite API services. They provide a scalable, simple, and secure user management API which makes building scalable systems simple.
Whenever I talk to people about using Stormpath, the same question invariably comes up: “Is it easy to export my user data out of Stormpath? Or am I locked in?”
Up until now, the answer has been “Yes! But only if you contact them about it.”
With stormpath-export, however, you can easily back up all your Stormpath user data instantly!
- Grab all Stormpath data you’ve stored, and dump it to JSON files locally.
- Dump data into a local directory structure which makes intuitive sense (groups are located in the groups directory, etc.).
- Each object gets it’s own JSON file generated. This makes it easy to look at the file system and extract the information you need.
stormpath-export makes it easy to:
- Download a copy of all your user data.
- Back up your user data (Stormpath has their own backups of course, but you can never be too safe).
- Migrate user data out of Stormpath.
Installing stormpath-export is simple – just use pip!
Once you have pip installed on your computer, you can run the following to install the latest release of stormpath-export:
$ pip install -U stormpath-export
That’s it :)
Before you can export all your Stormpath data, you’ll need to configure stormpath-export and give it your Stormpath API credentials. To do this, simply run:
$ stormpath-export configure
This will prompt you for some basic information, then store your credentials in the local file ~/.stormy.
NOTE: If you are using Stormpath Enterprise, please enter https://enterprise.stormpath.io/v1 when prompted for the Base URL. This instructs the export tool to talk to the Stormpath Enterprise environment.
Next, to initiate a backup job, you can run:
This will export all your Stormpath data, and dump it into a new directory named stormpath-exports. If you’d like to specify your own backup location, you can do so by adding a path – for instance:
$ stormpath-export ~/Desktop/stormpath-exports
When exporting your data, you should see output similar to the following:
=== Exporting all application data... - Exporting application: Stormpath === Done! === Exporting all directory data... - Exporting directory: Stormpath Administrators - Exporting directory: testdirectory === Done! === Exporting all group data... - Exporting group: Administrators === Done! === Exporting all account data... - Exporting account: firstname.lastname@example.org === Done!
Depending on how many applications, groups, directories, organizations, and accounts you have, this process may take a while.
Once the process is finished, you can navigate the JSON files in the export directory, which will contain all your Stormpath data.
For full usage information, run stormpath-export -h:
$ stormpath-export -h stormpath-export ---------------- Easily export your Stormpath (https://stormpath.com/) user data. Usage: stormpath-export configure stormpath-export [(<location> | -l <location> | --location <location>)] stormpath-export (-h | --help) stormpath-export --version Options: -h --help Show this screen. --version Show version. Written by Randall Degges <http://www.rdegges.com/>.
Need help? Can’t figure something out? If you think you’ve found a bug, please open an issue on the Github issue tracker.
Otherwise, shoot us an email.
- Importing missing dependency.
- Supporting --base-url argument.
- Making the tool Python 3 compatible.
- Supporting API key exports.
- Supporting Organization exports.
- Fixing documentation.
- Updating Stormpath dependency.
- Fixing version information.
- Supporting private deployments.
- Supporting Account API key backups.
- Completely re-doing export structures – much more sane now.
- Adding IDs, hrefs, and all fields to all backups.
- Still needs to support Social / ID site / Verification templates.
- Making the application export back up directory mappings.
- Backing up customData for all resource types.
- Upgrading dependencies.
- Making application export include directory name for clarity.
- Fixing bug with groups.
- Adding support for custom data exporting.
- Including new Stormpath SDK.
- First super-beta release of the project. WOO.
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|stormpath_export-0.1.2-py2.py3-none-any.whl (11.5 kB) Copy SHA256 hash SHA256||Wheel||2.7||Dec 27, 2016|
|stormpath-export-0.1.2.tar.gz (11.5 kB) Copy SHA256 hash SHA256||Source||None||Dec 27, 2016|