RapidIdentity Product Guide

Identity Bridge: Quick Start Guide

This guide will walk you through the process of creating a connection between RapidIdentity and your local resources using Identity Bridge.


An Administrator assigned the "Tenant Admin" role in the RapidIdentity Portal is required to access Identity Bridge configuration options.

There are three main steps to set up a new bridge:

System Requirements

To install and run the Identity Bridge agent on a Windows server, you must have the following specifications available:

Table 97. Identity Bridge System Requirements

System Element









10Mbps (Tested down to 1Mbps)


Windows Server 2012 or higher

Configure the Identity Bridge Agent Settings in RapidIdentity
  1. From the Configuration module, select Identity Bridge from the Systems menu.

  2. Click Add Agent+ either in the workspace or the upper right-hand action button.

  3. In the General Settings section, enter a Name and Description for the bridge.

    1. Select Enable Proxy to allow the configuration of the internet proxy connections if required by the local system service to connect to the internet.

  4. Click Save.

  5. Copy the Registration Code that appears in the information box at the top of the General Settings screen.



    This code is required when installing the agent software.

Install the Identity Bridge Agent Service on the Local Server


No inbound ports are required to be opened for the Identity Bridge agent installed on-premises. The only outbound port that needs to be allowed through firewalls for the agent is TCP 443.

  1. From the Configuration module, select Identity Bridge from the Systems menu.

  2. Click Download Installer from the action buttons at the bottom of the screen to download the RapidIdentity Identity Bridge Agent to your local server.

  3. Locate the download on the local server and run IdentityBridgeAgent.exe.

  4. The Identity Bridge Agent Setup Wizard will launch.

  5. Click Install.

  6. In Tenant Information, enter the Tenant URL and Registration Code. The Registration Code will match the code provided in Step 5 of the "Configure the Identity Bridge Agent Settings in RapidIdentity" section.

  7. Click Next.

  8. Click Finish.


    The connection should now be established with the RapidIdentity Identity Bridge Agent.

  9. Return to the Identity Bridge section in the Configuration Module. The newly added Agent tile in the workspace will display the connection status.

    1. If a "Heartbeat" status was returned, the connection is successful.

Add a Bridge in RapidIdentity to Provide Access to an On-premise Resource
  1. From the Configuration module, select Identity Bridge from the Systems menu.

  2. Click Details from the recently added agent tile.

  3. In the Agent Details, scroll down to the Bridges section. After the Agent has been successfully installed, the option to Add Bridge is now available.

  4. Click Add Bridge and enter the Name, On-Premise Host IP address, and On-Premise Port information in the Add Bridge details.

    1. The On-Premise Host IP address and the On-Premise Port information are from the system on which the Agent is being installed. For example, if the service being bridged is a database that is accessible from the Agent server as "database.local" on "port 5432," then chose those values.

  5. Click Save.

  6. The ability to test or delete the bridge will become available after the bridge is successfully deployed. There are several available statuses:

    1. Deploying: Initial status when the bridge is first saved

    2. Deployed: The status after the bridge is successfully deployed

    3. Destroying: The status while the bridge is being removed from the list

  7. After the bridge has been successfully deployed, select the bridge from the Bridges list and clickTest Bridge.

  8. The successfully created bridge will register the configuration information in the Test window.