OpenID Connect

OpenID Connect is an identity layer on top of the OAuth 2.0 protocol. You can verify the identity of the end user based on the authentication performed by an authorization server, as well as to obtain basic profile information about the end user. You can use any provider that supports the OpenID Connect protocol.

Configuring an OpenID Connect authentication provider

To add OpenID Connect on top of your OAuth2 configuration, enter the required information in the fields listed below.

Authentication Provider Information

Name—enter a user-friendly name for the authentication provider.
Provider Type—select OpenID Connect.
Enabled—the provider is enabled by default. However, you can disable it.
Site URL—set the URL that users enter in the browser to access an instance of Relativity.

Authentication Provider Settings

OAuth2 Flow—select either Implicit or Code.
Client ID—enter your application's ID.
Display on Login Screen—determines if the OpenID Connect button displays on the login page.
Login Screen Button Text—determines the text that appears on the button displayed on the login page.
Authority URL—enter the URL that hosts the OpenID configuration well-known endpoint.
Scopes—the default value for this field is openid. The openid checkbox must be selected because it's a required setting. However, you can also select the email or profile option. The identity provider responds with the claims associated with the scopes that you request. In other words, the scopes translate into claims that you can use.
Redirect URL—After saving the new Authentication Provider RDO (Relativity Dynamic Object), it will be shown in the settings.
- Example—<https://company.relativity.one/Relativity/Identity D7158859-3355-46FB-96D1-78B1B0466AB1>
Subject Claim Type—the default value for this field is sub. Enter one of the following values based on the scopes that you set:
- If you selected only OpenID in the Scopes field, this field must be set to sub.
- If you selected OpenID and email in the Scopes field, set this field to email.
- If you selected OpenID and profile in the Scopes field, set this field to a property available from the identity provider. These properties differ for each provider.
The identity provider sends an identity token to you, which contains the claims for your selected scopes. When you request only the openid scope, then sub is used as the claim type. It often represents a unique identifier for the user within your system. If you are using Azure AD, then see Microsoft identity platform ID tokens for a full list of token identifiers.

OpenID Connect authentication provider flows

There are two authentication provider flows used with Relativity: code flow and implicit flow. Below are two images showing a detailed OpenID Connect authentication flow for both.

Just-in-time provisioning

Just-in-time provisioning lets an admin control access Relativity environments through an external ID provider, such as Okta. Instead of creating groups in Relativity, they can be created in Okta or similar provider. When created in another provider and mapped in Relativity, the required login objects are automatically created in Relativity.

JIT provisioning takes user claims from the access token provided by the external ID provider and uses the claims to setup a User for login to Relativity.

JIT User Provisioning automatically creates the objects necessary for login, and the Required Claims feature restricts users from using JIT User Provisioning. For example, this feature can be used to restrict access to a tenant to users within a geographic region.

When a user logs in, Relativity checks to see if the client exists, then checks if the user exists. If both exist, Relativity then checks to see if the user group exists. If all these items exist, the user can log into Relativity. Personal group and Group claim mapping assignments are checked on every login. Users are assigned/removed to groups on every login, based on the Group Claim Mappings. For more information, see Group claim mapping .

Note: OpenID Connect only, not supported for SAML.

To set up just-in-time provisioning on the authentication provider page, complete the fields below.

Implement—Whether JIT Provisioning is enabled or disabled.
Client—This sets the Relativity Client a user is assigned to when provisioned.
Username Claim Type—the Claim Type used to set a user’s username. This should be mapped the claim containing the email address.
First Name Claim Type—the Claim Type used to set a user’s first name.
Last Name Claim Type—the Claim Type used to set a user’s last name.
Personal Group—toggle used to set if a Personal Group should be created for a user.
Personal Group Claim Type—the Claim Type used to set the personal group’s name.
Group Claim Type—the Claim Type used with Group Claim Mappings when determining group assignments for a user.
Default Trusted IPs—a list of IP address values that are automatically set to the user’s TrustedIPs setting.

Group claim mapping

This section will add the users to the specified group on login. The groups need to be existing in Relativity. A token can include two or more group mappings. Group assignments from Group Claim Mappings are performed on every login.

User Claims are provided by a client’s identity provider. Relativity does not control the claims assigned to a user. Relativity only checks that the claims are present when provisioning a user. The claims are passed to Relativity in the access token from the client’s identity provider during the login process.

Note: Group mapping claim values must be present in the token. Just-in-time user provisioning cannot query external endpoints (such as AzureAD's graph API) to determine group membership.

Any matching claims are then compared to the Group Claim Mappings. Claim values that match the Group Claim Mappings determine which group to assign a user as a member. If the user claims do not match any Group Claim Mappings, then the user is removed from that group.

Groups that users are added to outside of group claim mappings need to be administered manually.

Required claim

Required Claims is an optional setting that System Admins can configure on their authentication providers. Required claims is used to control what users gain access to a tenant. JIT user provisioning automatically creates the objects necessary for login, and the Required claims feature restricts users from using JIT user provisioning. For example, this feature can be used to restrict access to a tenant to users within a geographic region.

This setting is used with JIT-enabled authentication providers. Admins can set a list of claims that Relativity will check for when provisioning a user. A user must have at least one required claim to be a provisioned user. System Admins can set multiple claims as Required Claims, and a user must have at least one to pass the check.

The Required Claims check only works on the initial login. It will deny a user from being provisioned. If a user already exists in the system, then Required Claims does not affect login.

Personal claim group

The Personal Group feature allows for controlling permissions at the user level within Relativity. Normally, permissions in Relativity are set on the Group object. By creating a group for every user in Relativity (a user’s personal group), you can effectively set permissions for individual users. This is an optional feature.