Federated instances

Federated instances provide a way for reviewers to easily switch to other Relativity environments. In Relativity, links to federated instances appear in the User drop-down.

User dropdown

For more information, see User options.

You can use federated instances in combination with OAuth2 clients and authentication providers to enable single sign-on for multiple environments in your Relativity ecosystem.

This page contains the following information:

See these related pages:

Creating or editing a federated instance

To create a federated instance or edit information for an existing federated instance:

  1. Open the Federated Instances tab.
  2. Click New Federated Instance to create a new federated instance, or click Edit next to the federated instance you want to edit. The Federated Instance Information form appears.
  3. Complete the following fields:
    • Name – the name of the federated instance. Enter a name that makes the instance easy for users to recognize, like RelativityOne Reviewer.

      Note: You can't change the name of an existing federated instance.

    • Instance URL – the URL address of the instance you want to create a link to. To obtain this URL, navigate to the Relativity instance you want to appear in the dropdown. Copy and paste the URL from that instance into this field.

      You can also choose to add the Home Realm Discovery (HRD) parameter to mimic single sign-on experience inside your Relativity cluster. HRD is a redirect URL to a configured authentication provider for the federated instance. It is supported for OpenId Connect, Integrated Authentication, and Client Certificate providers.

      The HRD parameter value can be found in the individual provider details on the Authentication Provider tab. Generally, it is as follows:

      • OpenId Connect – the name of the authentication provider:
        https://mycompany.com/Relativity?HRD=<Provider Name>
      • Winauthintegrated:
        https://mycompany.com/Relativity?HRD=integrated
      • Client Certificatesmartcard:
        https://mycompany.com/Relativity?HRD=smartcard

      By setting the HRD Hint, you enable the users to automatically sign into another instance by clicking the federated instance link from the user dropdown. Note that the authentication provider must be set up correctly for single sign-on to work. If the authentication by the provider fails, the user will be presented with the login screen of the Federated Instance.

      Federated Instance Information

  4. Click Save.
  5. The federated instance appears in the User dropdown.

You can restrict access to the federated instances you create using the padlock icon and assigning the appropriate groups access to the instance. If you restrict access to a federated instance, it doesn't appear in the User dropdown.

Deleting a federated instance

To delete a federated instance:

  1. From the Federated Instance tab, locate and open the federated instance you wish to delete.
  2. Click Delete.
  3. From the confirmation dialog, click Ok. The federated instance is removed.

Viewing a federated instance audit history

Use the federated instance audit history to view all actions taken on a record. Use this information to view what the values were prior to a change.

To view a federated instance's audit history:

  1. From the Federated Instance tab, locate and click the federated instance for which you wish to view its history.
  2. Click View Audit. A dialog appears, listing all actions taken on that federated instance.
  3. (Optional) Using the Export to File drop-down at the bottom of the dialog, click Go to export the following audit history details in a .CSV file:
    • User Name
    • Action
    • Timestamp
  4. Close the dialog when finished viewing the audit.