This is not the latest version of Identity Director documentation.
View available documentation.

Upgrade Identity Broker

For a full explanation of Identity Broker and the complete instructions for a new installation, please see Getting Started with Identity Broker.

The instructions below are valid for an upgrade from Identity Broker 10.2 or earlier.
If you are upgrading from Identity Broker 2020.0.0, please read this topic.


Identity Broker 2020.0.0 (internal version contains a known issue, where users get an error message when they try to authenticate after upgrading from previous versions.

To prevent this service disruption, please perform the following steps on the Identity Broker server before performing the upgrade:

  1. In the installation folder of Identity Broker (located by default at C:\Program Files\RES\Identity Broker), go to the Config folder.
  2. Locate the Settings.config file and open it, for example in Notepad.
  3. In the file, in the <appSettings> node, add:
    <add key="InstrumentationKey" value="95ad5228-59f4-42db-8c3f-3a431da6b2eb" />
  4. Save your changes.
    If you get an 'Access denied' error, start Notepad using Run as administrator, open the file from there and return to step 3.

These steps can also be performed after installing Identity Broker 2020.0.0.


  1. Run the Ivanti Identity Director Installer on the target device.
  2. When prompted, choose Select and install components and click Next.
  3. In the Features section, select Identity Broker.
    Optionally, you can select other components. Instructions for these components are available in separate topics.
    Click Next, then Install and follow the Setup Wizard(s).
    When the Identity Broker Setup Wizard starts:
  4. Click Next and follow the Setup Wizard.
  5. In the Configure Other Settings step, select the Provider Hosts (used for authentication) you want to install on this server.
    Click Next followed by Install to start the installation.
    • Follow the Setup Wizard of any Provider Hosts you selected (started automatically).
      In the Configure Identity Broker Access step for these hosts, the pre-filled values for Identity Broker Address, Unique Callback Path and Realm should work as they are.
      Click Next followed by Install.
    • Click Finish.
  6. Click Finish and Close.
    The upgrade is now complete, but users will get a 404-error when they try to authenticate.
    To resolve this:
  7. Open IIS and restart the RES site.
    Authentication should now be restored.
  8. Open the Identity Broker Management Portal and press F5.
    This will display the new look and feel of the Management Portal and will correctly display new features.