SSO Settings are backed up as part of AuthAnvil Two Factor Auth but we also recommend backing them up separately.
An AuthAnvil backup file stores all of your user, token, and logging information in a format that can be easily imported back into the database.
Note: Backups also include all of your encryption keys, and the file itself is not protected in any way, so it can easily be accessed and modified.
Important: Access to your backups should be locked down. You will want your backups stored securely and their access controlled.
Supported file formats are:
*.SBP (Compressed binary file).
*.XML (XML text file).
Note: Using the .SBP file type will create a more compressed backup than .XML. Example "ssobackup.sbp".
Commands and Triggers
- -b Backup
- -r Restore
- -t Truncate section on backup or ignore sections on backup and restore
- Audit: Audit table
- Exception: Exception table
- Scheduler: Scheduler table
- TraceRecord: TraceRecord table
Below is the correct Syntax format for truncating tables.
ScorpionSoft.IdentityServer.Backup.exe -b:ssobackup.sbp
or for restore
ScorpionSoft.IdentityServer.Backup.exe -r:ssobackup.sbp
For truncating multiple tables you can use the format below. Just make sure you put a space between each table you wish to truncate.
ScorpionSoft.IdentityServer.Backup.exe -t -Audit -Exception -b ssobackup.sbp
Backup your existing data
- Open an Elevated Command Prompt (Run as Administrator) and navigate to the following folder.
C:\Program Files\Scorpion Software\AuthAnvil\AuthAnvilTools\SSOBackupTool
- To run the backup, run the command ScorpionSoft.IdentityServer.Backup.exe followed by -b and the preferred file name.
i.e. ScorpionSoft.IdentityServer.Backup.exe -b “ssobackup.xml”
- Your backup file is created and saved in the same directory from where you ran the command. If the backup is successful, the tool will complete silently. If you receive an error make sure you have the correct SQL instance name, verify that your user account has privileges to access the database and run the backup again.
Restoring your existing data
- Open an elevated command prompt (run as Administrator) and navigate to the following folder.
C:\Program Files\Scorpion Software\AuthAnvil\AuthAnvilTools\SSOBackupTool
- To run the Restore, run the command ScorpionSoft.IdentityServer.Backup.exe followed by -r and the preferred file name.
i.e. ScorpionSoft.IdentityServer.Backup.exe -r:“ssobackup.sbp”
Questions?
If you have any questions or need some help, we would be happy to assist. Open a case at help.scorpionsoft.com or send an email to support@scorpionsoft.com.