Using the Graph API for communications

To use the Graph API for legal hold communications, you need to register the Relativity Legal Hold application in Azure AD and set your processor type to Graph API in Relativity. For more information on setting your processor type, see Adding email settings.

Registering an Azure application and credentials

To us the Microsoft Graph API, you need to register the Relativity Legal Hold application. Authentication requires a reference to a dedicate Azure application that has the appropriate permission. This needs to be done on the client side by an Azure user with sufficient rights.

Start registering your app by following the steps below:

Note: The application registration process needs to be done by an Azure Administrator with sufficient privileges.

  1. Open your Azure Portal.
  2. In the left-navigation menu, click App registrations.
  3. Click New Registration.
    This will open the Register an application page.
  4. Enter an application name in the Name field.
  5. Select Accounts in this organizational directory only as the supported account type.
  6. Click Register.

For more information on registering an application in Azure, see Microsoft's documentation or How to authenticate an EWS application by using OAuth..

Adding permissions to the registered application

Next, from the app's page, add permissions to the web API by following the steps below:

  1. Click API Permissions.
  2. Click Add a permission.
  3. Click Microsoft Graph.
  4. Select Delegated Permissions.
  5. Select the following options from the Delegated Permissions section:

    • Mail – Mail.Send, Mail.ReadWrite

    • User – User.Read

  6. Click Add Permission.

  7. Click Grant Permission.

Configuring the redirect URL

In Azure Portal, navigate to the Overview page for the application being used for the integration. Follow the steps below.

  1. Using the left navigation column, click into the Authentication page.

  2. Click the Add a platform button.

  3. Click the Web drop-down text.

  4. Paste in your Redirect URL.

      Notes: Replace the bold part of the URL with your organization's subdomain, domain, and top-level domain.
    • Format: https://{RelativityURL}/Relativity.Rest/API/kCura.LegalHold.Services.ILegalHoldModule/Graph%20Authorization%20Manager/graph-auth-response
    • Example: https://yourorganization.relativity.one/Relativity.Rest/API/kCura.LegalHold.Services.ILegalHoldModule/Graph%20Authorization%20Manager/graph-auth-response

  5. Click the Configure button.

For more information on adding a redirect URL to Azure, see Microsoft’s documentation.

Creating a client secret

A client secret from Microsoft Azure AD is needed to integrate Microsoft and Relativity. To create a client secret, follow the steps below.

  1. In the left-navigation menu, click Certificates & secrets.

  2. Navigate to the Client secrets tab.

  3. Click the New Client Secret button.

      Notes: Don't navigate away from the page once the client secret is created.

  4. Populate the Description and Expires fields. You can leave the default, or recommended, values.

  5. Click the Add button.
    If the client secret was successfully created, you will see the Client Secret displayed on the table and the Value field should be displayed in plain text.

  6. Copy the Value field and store it safely.

If you leave the page and comeback to get the value the Value field will be masked and you will not be able to copy it

You can repeat steps 4-5 to generate a new client secret.

After you complete registering your app and have your client secret, you need to add this information to your email settings. For more information, see Adding email settings.