<PackageReference Include="Relativity.Identity.SDK" Version="2.6.2" />

IUserManager

public interface IUserManager : IDisposable
Service for managing Relativity Users
Task<UserResponse> CreateAsync(UserRequest userRequest)

Adds a single user to Relativity.

Task DeleteAsync(int userID)

Deletes a user.

Task DeleteAsync(int userID, CancellationToken cancel)

Deletes a user.

Task<List<DisplayableObjectIdentifier>> GetAvailableTypesAsync()

Gets all possible types for the User

Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users)

Query for Groups that are eligible for adding at least one of specified users.

Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users, IProgress<ProgressReport> progress)

Query for Groups that are eligible for adding at least one of specified users.

Task<QueryResultSlim> QueryEligibleGroupsToAddUsersToAsync(QueryRequest request, int start, int length, ICollection<ObjectIdentifier> users, CancellationToken cancel, IProgress<ProgressReport> progress)

Query for Groups that are eligible for adding at least one of specified users.

Task<QueryResultSlim> QueryGroupsByUserAsync(QueryRequest request, int start, int length, int userID)

Task<WorkspaceUserData> ReadActiveUsersAsync(int workspaceID, bool includeCurrentUser = true, bool enforceChoiceLimitForUI = false)

Asynchronously retrieves a list of all active users in a workspace. If the number of returned users exceeds the ChoiceLimitForUI setting, no users will be returned.

Task<WorkspaceUserData> ReadAllUsersAsync(int workspaceID, bool includeDeleted = false)

Asynchronously retrieves a list of all users in a workspace, including administrators and (optional) deleted users.

Task<UserResponse> ReadAsync(int userID, bool includeMetadata = false, bool includeActions = false)

Retrieves advanced metadata for a user, including their Relativity access, name, email, and other properties.

Task<UserSettingResponse> ReadSettingsAsync(bool includeMetadata = false, bool includeActions = false)

Retrieves settings for the current user, including their name, email, and other properties.

Task<List<UserInfo>> RetrieveAll(int workspaceID)

Gets a list of all users and their information for a given workspace.

Task<WorkspaceUserData> RetrieveAllWithRelativityAccessAsync(int workspaceID)

Asynchronously retrieves a list of users from the specified workspace that have Relativity access (use -1 for Admin workspace).

Task<User> RetrieveCurrentAsync(int workspaceID)

Asynchronously retrieves the current user in the specified workspace. NOTE: User Artifact ID may differ for the same user in different workspaces.

Task<UserInfoQueryResultSet> RetrieveUsersBy(int workspaceID, QueryRequest query, int start, int length)

Gets a list of users and their information, and supports filtering, ordering, and paging these results.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest)

Modifies the properties of a user.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn)

Modifies the properties of a user.

Task<UserResponse> UpdateAsync(int userID, UserRequest userRequest, DateTime lastModifiedOn, CancellationToken cancel)

Modifies the properties of a user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest)

Modifies the user setting properties of the current user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, CancellationToken cancel)

Modifies the user setting properties of the current user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn)

Modifies the user setting properties of the current user.

Task<UserSettingResponse> UpdateSettingsAsync(UserSettingRequest userSettingRequest, DateTime lastModifiedOn, CancellationToken cancel)

Modifies the user setting properties of the current user.