Documentation

 

 

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
UI Text Box
typewarning

This tool will not work with SecureAuth IdP version 9.3. SecureAuth advises customers to engage SecureAuth Support before using this tool to ensure no issues are caused as a result of changes made by this tool on SecureAuth IdP.

Panel
borderColor#000000
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#000000
borderStylesolid
titleIntroduction

Use this guide to install and use the Realm Management Tool, which enables the creation, deletion, and renaming of SecureAuth IdP realms.

Panel
borderColor#444443
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#444443
borderStylesolid
titlePrerequisites

SecureAuth IdP appliance on Microsoft Windows Server 2008 R2, 2012, or 2012 R2 

Info
titleDisclaimer

THIS SOFTWARE IS PROVIDED "AS IS" AND SECUREAUTH CORPORATION DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL SECUREAUTH CORPORATION BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHAT SO EVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

Panel
borderColor#135570
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#135570
borderStylesolid
titleRealm Management Tool Installation and Utilization
Localtab Group
Localtab
titleInstallation

1. Download the Realm Management Tool installer from https://www.secureauth.com/support/downloads/support-tools

2. Navigate to the download, right-click on the archive, select Properties, and switch to the General tab

3. If there is a button titled Unblock present in the tab, click it, and press OK to dismiss the Properties window

4. Navigate to the download, right-click on the archive, and select Extract All...

5. Extract the archive to D:\MFCApp_Bin\Extras

Localtab
titleCreate Realm(s)

1. To create realms on the SecureAuth IdP Appliance, navigate to D:\MFCApp_bin\Extras\RealmManagementTool and run RealmManagementTool.bat

The Splash page displays

The Legal disclaimer displays

2. Type AGREE at the prompt to accept the terms, and press Enter and continue to step 3

Info

If the terms are not agreeable, press Enter and the script exits automatically

The Main Menu displays

3. Type 1 and press Enter to create realms

The Preflight screen displays

3. Enter the realm number(s) to create

Info

To create a single realm, enter only its number (e.g. 50)

To create multiple realms, enter their numbers, separated by a comma (e.g. 50,51,52)

4. Enter the realm number that is to be used as a template

Info

SecureAuth0, SecureAuth998, and SecureAuth999 cannot be used as a template

The realms selected will now be created


Localtab
titleDelete Realm(s)
Warning

The delete operation will permanently remove the realm(s) from the SecureAuth IdP Appliance

Unless a backup has been made with the the SecureAuth Backup Tool or another backup program, these realms cannot be recovered

1. To delete realms on the SecureAuth IdP Appliance, navigate to D:\MFCApp_bin\Extras\RealmManagementTool and run RealmManagementTool.bat

The Splash page displays

The Legal disclaimer displays

2. Type AGREE at the prompt to accept the terms, and press Enter and continue to step 3

Info

If the terms are not agreeable, press Enter and the script exits automatically

The Main Menu displays

3. Type 2 and press Enter to delete realms

The Preflight screen displays

Info

To delete a single realm, enter only its number (e.g. 50)

To delete multiple realms, enter their numbers, separated by a comma (e.g. 50,51,52)

4. Enter the realm number(s) to delete


5. Carefully read the warning message and type OK to continue with the delete operation, or type CANCEL to abort the delete operation

The realms selected will now be deleted


Localtab
titleBulk Create Realms
Info

The Bulk Create Realms feature is used when there is a need for many realms to be created at once

Note that the realm numbering must be contiguous for this options to work (e.g. 10-30)

1. To bulk create realms on the SecureAuth IdP Appliance, navigate to D:\MFCApp_bin\Extras\RealmManagementTool and run RealmManagementTool.bat

The Splash page displays

The Legal disclaimer displays

2. Type AGREE at the prompt to accept the terms, and press Enter and continue to step 3


The Main Menu displays

3. Type 3 and press Enter to Bulk Create Realms

The Preflight screen displays

4. Enter the starting realm number for the range to create (e.g. 10 if creating realms 10-30)

5. Enter the ending realm number for the range to create (e.g. 30 if creating realms 10-30)

6. Enter the realm number that is to be used as a template

Info

SecureAuth0, SecureAuth998, and SecureAuth999 can not be used as a template

The realms selected will now be created


Localtab
titleRename Realm
Warning
titlePortal Page

Do not use these instructions if your site has a Portal page it does not yet support SecureAuth realms with custom naming schemes. Changing a realm name will break the link on the portal page and present users with an error. As an alternative you can create a User Friendly (vanity) URL. Please see the SecureAuth support document User Friendly URL Best Practice for further information on that process

 

1. To rename realms on the SecureAuth IdP Appliance, navigate to D:\MFCApp_bin\Extras\RealmManagementTool and run RealmManagementTool.bat

The Splash page displays

The Legal disclaimer displays

2. Type AGREE at the prompt to accept the terms, and press Enter and continue to step 3

The Main Menu displays

3. Type 4 and press Enter to Rename Realms

4. Carefully read the warning message and type OK to continue with the renaming operation, or type CANCEL to abort the renaming operation

 5. Enter the realm name to rename (e.g. SecureAuth9)

6. Type in the new name for the realm


The realm selected will now be renamed