

Last date modified: July 07 2025
The login profile defines how an individual user logs into Relativity by setting user-specific options for each provider in the authentication profile. Each entry in the user's login profile corresponds to a matching entry in the environment's authentication profile, such as Provider in the environment for Password, Integrated Authentication, Active Directory, RSA, and Client Certificate.
The Login Profile Manager API is uses to configure authentication profiles and user login profiles:
You can interact with the Login Profile Manager using the ILoginProfileManager interface. The methods on the interface allow you to retrieve and update a user's login profile and Relativity's authentication profile. You can also send out login invitation emails and manually set passwords.
You can also use the Login Profile Manager API through REST. For more information, see Login Profile Manager (REST).
Review the following information to learn about the methods and classes used by the Login Profile Manager API.
Before programmatically interacting with login profiles, familiarize yourself with the Relativity authentication provider user interface and review the information in the RelativityOne Documentation site. Note there is a strong correlation between the API operations and object properties and the user interface elements.
Use these guidelines when working with authentication methods:
The following code sample shows how to read in a User Login Profile and create a login method for an OpenIDConnect provider.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
using (Relativity.Identity.{versionNumber}.Services.ILoginProfileManager loginProfileManager = new ServiceFactory(settings).CreateProxy<ILoginProfileManager>())
{
LoginProfile profile = await loginProfileManager.GetLoginProfileAsync(1012311);
if(profile.OpenIDConnectMethods.SingleOrDefault(x => x.ProviderName.Equals("My OIDC Provider")) == null)
{
OpenIDConnectMethod oidcMethod = new OpenIDConnectMethod() {
IsEnabled = true,
ProviderName = "My OIDC Provider",
Subject = "0e58f970-2113-4a6e-8655-82c10e6d9412"
};
profile.OpenIDConnectMethods.Add(oidcMethod);
loginProfileManager.UpdateLoginProfileAsync(1012311, profile);
}
}
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!
Additional Resources |
|||
DevHelp Community | GitHub | Release Notes | NuGet |