User Manager (REST)
Users are individuals who have access to the Relativity environment. For general information, see Users on the Relativity Documentation site. The User Manager API exposes multiple operations that you can use to programmatically manage users in your Relativity environment. It includes the following features:
- Supports create, read, update, and delete operations on users.
- Supports read and update operations on the settings of the current users.
- Provides helper methods used to retrieve the available user types.
- Retrieval of all users from a workspace or admin-level context.
Sample use cases
- Developing a custom tool to import users in Relativity.
- Updating properties like the name or the email of the logged user or any other user in Relativity.
- Retrieve user information for display in a view for a custom application.
You can also use the User service through the .NET API. For more information, see User Manager (.NET).
This page contains the following information:
Fundamentals for managing users
The URLs for REST endpoints contain path parameters that you need to set before making a call:
- Set the {versionNumber} placeholder to the version of the REST API that you want to use, using the format lowercase v and the version number, for example v1 or v2
- Set other path parameters in the URLs to the Artifact ID of a given entity, for example setting {workspaceID} to the Artifact ID of a workspace.
Note: To indicate the admin-level context, set the {workspaceID} path parameter to -1.
Refer to Fundamentals for managing users for more information.
Client code sample
To use the User Manager service, send requests by making calls with the required HTTP methods. You can use the following .NET code as a sample client for creating a user.
public async Task<UserResponse> CreateUserAsync() { using (HttpClient client = new HttpClient()) { client.DefaultRequestHeaders.Add("X-CSRF-Header", "-"); client.DefaultRequestHeaders.Add("Authorization", "Basic " + Convert.ToBase64String(Encoding.GetEncoding("ISO-8859-1").GetBytes("test@test.com:SomePassword"))); client.DefaultRequestHeaders.Add("X-Kepler-Version", "2.0"); client.BaseAddress = new Uri("http://localhost/"); string inputJSON = "{\"UserRequest\":{\"AllowSettingsChange\": true,\"Client\": {\"Secured\": false,\"Value\": {\"ArtifactID\": 1015644}},\"DefaultFilterVisibility\": true,\"DocumentViewerProperties\": {\"AllowDocumentSkipPreferenceChange\": true,\"AllowDocumentViewerChange\": true,\"AllowKeyboardShortcuts\": true,\"DefaultSelectedFileType\": \"Default\",\"DocumentViewer\": \"Default\",\"SkipDefaultPreference\": true},\"DisableOnDate\": null,\"EmailAddress\": \"test222@relativity.com\",\"EmailPreference\": \"Default\",\"FirstName\": \"First Name\",\"ItemListPageLength\": 50,\"LastName\": \"Last Name\",\"RelativityAccess\": true,\"SavedSearchDefaultsToPublic\": true,\"TrustedIPs\": \"\",\"Type\": {\"ArtifactID\": 663},\"Keywords\": \"\",\"Notes\": \"\"}}"; string url = "/Relativity.REST/api/Relativity-Identity/{versionNumber}/users"; HttpResponseMessage response = await client.PostAsync(url, new StringContent(inputJSON, Encoding.UTF8, "application/json")); response.EnsureSuccessStatusCode(); string content = await response.Content.ReadAsStringAsync(); return JsonConvert.DeserializeObject<UserResponse>(content); } }
Create a user

Note: Before creating a user, you need to identify the client and the user type.
To create a new user, send a POST request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/users
The body of the request must contain the following fields unless specifically identified as optional:
- UserRequest - represents a request for creating a user. It includes the following fields:
- AllowSettingsChange - a Boolean value indicating whether the user will be able to change a limited number of their settings.
- Client - the client associated with the user.
- Secured - indicates whether the current user has permission to view the setting in the Value field.
- Value - the Object Identifier of the client.
- DefaultFilterVisibility - a Boolean value indicating whether filters on all columns are visible by default.
- DocumentViewerProperties - user properties that are related to the document viewer.
- AllowDocumentSkipPreferenceChange - a Boolean value indicating whether the user has the ability to change their preference to skip documents during review that no longer meet the original conditions of a view due to propagation.
- AllowDocumentViewerChange - a Boolean value indicating whether the user will be able to change the document viewer modes.
- AllowKeyboardShortcuts - a Boolean value indicating whether the user can see the keyboard shortcuts icon in the core reviewer interface.
- DefaultSelectedFileType - the default viewer mode. See the DefaultSelectedFileType enumeration.
- DocumentViewer - the viewer that the user can access when reviewing documents. See the DocumentViewer enumeration.
- SkipDefaultPreference - a Boolean value indicating whether the user advances to the next document in the queue that matches the defined view conditions when the user clicks Save and Next.
- DisableOnDate - the date when the user's Relativity access will be auto-disabled.
- EmailAddress - the user's email address in the format name@domain.extension.
- EmailPreference - the user's preference for email notifications when adding or deleting Users or Groups. See the EmailPreference enumeration.
- FirstName - the user's first name.
- ItemListPageLength - the default list length for all views in Relativity for the user.
- LastName - the user's last name.
- RelativityAccess - a Boolean value indicating whether the user can to log in to Relativity and be considered for billing under your Relativity license.
- SavedSearchDefaultsToPublic - a Boolean value indicating whether saved searches are public or private by default.
- TrustedIPs - an IP address or addresses that are valid locations from which the user can log in from.
- Type - the user's type. Type is for reference purposes only and has no impact on access or billing.
- Keywords - optional words or phrases used to describe the user.
- Notes - an optional description or other information about the user.
{ "UserRequest":{ "AllowSettingsChange": true, "Client": { "Secured": false, "Value": { "ArtifactID": 1015644 } }, "DefaultFilterVisibility": true, "DocumentViewerProperties": { "AllowDocumentSkipPreferenceChange": true, "AllowDocumentViewerChange": true, "AllowKeyboardShortcuts": true, "DefaultSelectedFileType": "Default", "DocumentViewer": "Default", "SkipDefaultPreference": true }, "DisableOnDate": null, "EmailAddress": "email address", "EmailPreference": "Default", "FirstName": "First Name", "ItemListPageLength": 50, "LastName": "Last Name", "RelativityAccess": true, "SavedSearchDefaultsToPublic": true, "TrustedIPs": "", "Type": { "ArtifactID": 663 }, "Keywords": "", "Notes": "" } }
The JSON response will look similar to the following:
{ "AllowSettingsChange":true, "Client":{ "Secured":false, "Value":{ "Name":"Relativity", "ArtifactID":1015644, "Guids":[ ] } }, "DefaultFilterVisibility":true, "DocumentViewerProperties":{ "AllowDocumentViewerChange":true, "AllowKeyboardShortcuts":true, "AllowDocumentSkipPreferenceChange":true, "DefaultSelectedFileType":"Viewer", "DocumentViewer":"Default", "SkipDefaultPreference":true }, "EmailAddress":"email address", "EmailPreference":"All", "FirstName":"First Name", "ItemListPageLength":50, "LastName":"Last Name", "RelativityAccess":true, "SavedSearchDefaultsToPublic":true, "TrustedIPs":"", "Type":{ "Name":"Internal", "ArtifactID":663, "Guids":[ ] }, "Keywords":"", "Notes":"", "CreatedOn":"2020-04-29T20:04:24.617", "CreatedBy":{ "Name":"Doe, Jane", "ArtifactID":1023652, "Guids":[ ] }, "LastModifiedBy":{ "Name":"Doe, Jane", "ArtifactID":1023652, "Guids":[ ] }, "LastModifiedOn":"2020-04-29T20:04:24.617", "Meta":{ "Unsupported":[ ], "ReadOnly":[ ] }, "Actions":[ { "Name":"Delete", "Href":"Relativity.Users/workspace/-1/users/1018403", "Verb":"DELETE", "IsAvailable":true, "Reason":[ ] }, { "Name":"Update", "Href":"Relativity.Users/workspace/-1/users/1018403", "Verb":"PUT", "IsAvailable":true, "Reason":[ ] } ], "ArtifactID":1018403, "Guids":[ ] }
Retrieve metadata for a user

You can retrieve basic information about a user or extended information, which also includes operations that you have permissions to perform on the user.
To retrieve metadata for a user, send a GET request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/users/{userID:int}?{includeMetadata:bool}&{includeActions:bool}
The body of the request is empty. The response contains the following fields:
- AllowSettingsChange - a Boolean value indicating whether the user will be able to change a limited number of their settings.
- Client - the client associated with the user.
- Secured - indicates whether the current user has permission to view the setting in the Value field.
- Value - the Object Identifier of the client.
- Name - the name of the client.
- ArtifactID - the Artifact ID of the client.
- Guids - an array of GUIDs used to identify the client.
- DefaultFilterVisibility - a Boolean value indicating whether filters on all columns are visible by default.
- DocumentViewerProperties - user properties that are related to the document viewer.
- AllowDocumentSkipPreferenceChange - a Boolean value indicating whether the user has the ability to change their preference to skip documents during review that no longer meet the original conditions of a view due to propagation.
- AllowDocumentViewerChange - a Boolean value indicating whether the user will be able to change the document viewer modes.
- AllowKeyboardShortcuts - a Boolean value indicating whether the user can see the keyboard shortcuts icon in the core reviewer interface.
- DefaultSelectedFileType - the default viewer mode. See the DefaultSelectedFileType enumeration.
- DocumentViewer - the viewer that the user can access when reviewing documents. See the DocumentViewer enumeration.
- SkipDefaultPreference - a Boolean value indicating whether the user advances to the next document in the queue that matches the defined view conditions when the user clicks Save and Next.
- EmailAddress - the user's email address in the format name@domain.extension.
- EmailPreference - the user's preference for email notifications when adding or deleting Users or Groups. See the EmailPreference enumeration.
- FirstName - the user's first name.
- ItemListPageLength - the default list length for all views in Relativity for the user.
- LastName - the user's last name.
- RelativityAccess - a Boolean value indicating whether the user can to log in to Relativity and be considered for billing under your Relativity license.
- SavedSearchDefaultsToPublic - a Boolean value indicating whether saved searches are public or private by default.
- TrustedIPs - an IP address or addresses that are valid locations from which the user can log in from.
- Type - the user's type. Type is for reference purposes only and has no impact on access or billing.
- Keywords - optional words or phrases used to describe the user.
- Notes - an optional description or other information about the user.
- CreatedOn - the date and time when the user was added to Relativity.
- CreatedBy - contains the Artifact ID and name of the user who created the user.
- LastModifiedBy - contains the Artifact ID and name of the user who recently updated the user.
- LastModifiedOn - the date and time when the user was most recently modified.
- Meta - provides additional information available as extended metadata. It includes the following fields:
- Unsupported - a listed of fields not supported on the current instance of this user.
- ReadOnly - an array of user properties that can't be modified.
- Actions - an array of Action objects indicating operations that you have permissions to perform on this user. Each Action object contains the following fields that are available as extended metadata:
- Name - name of an operation available through REST for the user, such as delete, update, and so on.
- Href - the URL used to make an HTTP request for the operation.
- Verb - the name of the HTTP method for the operation.
- IsAvailable - a Boolean value indicating whether you have permissions to perform the operation on this user.
- Reason - provides an explanation for the unavailability of an action.
- ArtifactID - the Artifact ID of the user.
- Guids - an array of GUIDs used to identify the user.
The JSON response will look similar to the following:
{ "AllowSettingsChange":true, "Client":{ "Secured":false, "Value":{ "Name":"Relativity", "ArtifactID":1015644, "Guids":[ ] } }, "DefaultFilterVisibility":true, "DocumentViewerProperties":{ "AllowDocumentViewerChange":false, "AllowKeyboardShortcuts":true, "AllowDocumentSkipPreferenceChange":true, "DefaultSelectedFileType":"Viewer", "DocumentViewer":"Default", "SkipDefaultPreference":true }, "EmailAddress":"test@t.com", "EmailPreference":"All", "FirstName":"1", "ItemListPageLength":25, "LastName":"1", "RelativityAccess":true, "SavedSearchDefaultsToPublic":false, "TrustedIPs":"", "Type":{ "Name":"External", "ArtifactID":672, "Guids":[ ] }, "Keywords":"", "Notes":"", "CreatedOn":"2021-05-07T13:45:59.61", "CreatedBy":{ "Name":"Admin, Relativity", "ArtifactID":9, "Guids":[ ] }, "LastModifiedBy":{ "Name":"Admin, Relativity", "ArtifactID":9, "Guids":[ ] }, "LastModifiedOn":"2021-05-07T13:45:59.61", "Actions":[ ], "ArtifactID":1017952, "Guids":[ ] }
Retrieve settings of the current user

You can retrieve the settings of the current user or extended metadata, which includes information about the operations that you have permissions to perform on the user settings.
To retrieve settings for a user, send a GET request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/users/me/settings?{includeMetadata:bool}&{includeActions:bool}
The body of the request is empty. The response contains the following fields:
- Actions - an array of Action objects indicating operations that you have permissions to perform on this user. Each Action object contains the following fields that are available as extended metadata:
- Name - name of an operation available through REST for the user, such as delete, update, and so on.
- Href - the URL used to make an HTTP request for the operation.
- Verb - the name of the HTTP method for the operation.
- IsAvailable - a Boolean value indicating whether you have permissions to perform the operation on this user.
- Reason - provides an explanation for the unavailability of an action.
- DefaultFilterVisibility - a Boolean value indicating whether filters on all columns are visible by default.
- DefaultSelectedFileType - the default viewer mode. See the DefaultSelectedFileType enumeration.
- EmailAddress - the user's email address in the format name@domain.extension.
- EmailPreference - the user's preference for email notifications when adding or deleting Users or Groups. See the EmailPreference enumeration.
- FirstName - the user's first name.
- ItemListPageLength - the default list length for all views in Relativity for the user.
- LastName - the user's last name.
- Meta - provides additional information available as extended metadata. It includes the following fields:
- Unsupported - a listed of fields not supported on the current instance of this user.
- ReadOnly - an array of user properties that can't be modified.
- SavedSearchDefaultsToPublic - a Boolean value indicating whether saved searches are public or private by default.
- SkipDefaultPreference - a Boolean value indicating whether the user advances to the next document in the queue that matches the defined view conditions when the user clicks Save and Next.
The JSON response will look similar to the following:
{ "Actions":[ ], "DefaultFilterVisibility":true, "DefaultSelectedFileType":"Default", "EmailAddress":"relativity.admin@kcura.com", "EmailPreference":"All", "FirstName":"Relativity", "ItemListPageLength":25, "LastName":"Admin", "SavedSearchDefaultsToPublic":false, "SkipDefaultPreference":false }
Update the properties of a user

You can modify the properties of a user, such as its first name, email address, and others. Additionally, you can also restrict the update of a user to the date that it was last modified by adding the LastModifiedOn field to the request.
To update the properties of a user, send a PUT request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/users/{userID:int}
The request must contain the following fields unless specifically identified as optional:
- UserRequest - represents a request for updating a user. It includes the following fields:
- AllowSettingsChange - a Boolean value indicating whether the user will be able to change a limited number of their settings.
- Client - the client associated with the user.
- Secured - indicates whether the current user has permission to view the setting in the Value field.
- Value - the Object Identifier of the client.
- DefaultFilterVisibility - a Boolean value indicating whether filters on all columns are visible by default.
- DocumentViewerProperties - user properties that are related to the document viewer.
- AllowDocumentSkipPreferenceChange - a Boolean value indicating whether the user has the ability to change their preference to skip documents during review that no longer meet the original conditions of a view due to propagation.
- AllowDocumentViewerChange - a Boolean value indicating whether the user will be able to change the document viewer modes.
- AllowKeyboardShortcuts - a Boolean value indicating whether the user can see the keyboard shortcuts icon in the core reviewer interface.
- DefaultSelectedFileType - the default viewer mode. See the DefaultSelectedFileType enumeration.
- DocumentViewer - the viewer that the user can access when reviewing documents. See the DocumentViewer enumeration.
- SkipDefaultPreference - a Boolean value indicating whether the user advances to the next document in the queue that matches the defined view conditions when the user clicks Save and Next.
- DisableOnDate - the date when the user's Relativity access will be auto-disabled.
- EmailAddress - the user's email address in the format name@domain.extension.
- EmailPreference - the user's preference for email notifications when adding or deleting Users or Groups. See the EmailPreference enumeration.
- FirstName - the user's first name.
- ItemListPageLength - the default list length for all views in Relativity for the user.
- LastName - the user's last name.
- RelativityAccess - a Boolean value indicating whether the user can to log in to Relativity and be considered for billing under your Relativity license.
- SavedSearchDefaultsToPublic - a Boolean value indicating whether saved searches are public or private by default.
- TrustedIPs - an IP address or addresses that are valid locations from which the user can log in from.
- Type - the user's type. Type is for reference purposes only and has no impact on access or billing.
- Keywords - optional words or phrases used to describe the user.
- Notes - an optional description or other information about the user.
- LastModifiedOn - the date and time when the user was most recently modified. This field is only required if you want to restrict the update of a user to the date that it was last modified. The value must match the LastModifiedOn date for the user stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.
{ "UserRequest":{ "AllowSettingsChange":true, "Client":{ "Secured":false, "Value":{ "ArtifactID":1015644 } }, "DefaultFilterVisibility":true, "DocumentViewerProperties":{ "AllowDocumentSkipPreferenceChange":true, "AllowDocumentViewerChange":true, "AllowKeyboardShortcuts":true, "DefaultSelectedFileType":"Default", "DocumentViewer":"Default", "SkipDefaultPreference":true }, "DisableOnDate":null, "EmailAddress":"email address", "EmailPreference":"Default", "FirstName":"First Name", "ItemListPageLength":50, "LastName":"Last Name", "RelativityAccess":true, "SavedSearchDefaultsToPublic":true, "TrustedIPs":"", "Type":{ "ArtifactID":663 }, "Keywords":"", "Notes":"" } }
The JSON response will look similar to the following:
{ "AllowSettingsChange":true, "Client":{ "Secured":false, "Value":{ "Name":"Relativity", "ArtifactID":1015644, "Guids":[ ] } }, "DefaultFilterVisibility":true, "DocumentViewerProperties":{ "AllowDocumentViewerChange":false, "AllowKeyboardShortcuts":true, "AllowDocumentSkipPreferenceChange":true, "DefaultSelectedFileType":"Viewer", "DocumentViewer":"Default", "SkipDefaultPreference":true }, "EmailAddress":"test@t.com", "EmailPreference":"All", "FirstName":"1", "ItemListPageLength":25, "LastName":"1", "RelativityAccess":true, "SavedSearchDefaultsToPublic":false, "TrustedIPs":"", "Type":{ "Name":"External", "ArtifactID":672, "Guids":[ ] }, "Keywords":"", "Notes":"", "CreatedOn":"2021-05-07T13:45:59.61", "CreatedBy":{ "Name":"Admin, Relativity", "ArtifactID":9, "Guids":[ ] }, "LastModifiedBy":{ "Name":"Admin, Relativity", "ArtifactID":9, "Guids":[ ] }, "LastModifiedOn":"2021-05-07T13:45:59.61", "Actions":[ ], "ArtifactID":1017952, "Guids":[ ] }
Update the settings of the current user

You can modify the setting properties of the current user. Additionally, you can also restrict the settings update to the date that it was last modified by adding the LastModifiedOn field to the request.
To do update the settings of the current user, send a PUT request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/users/me/settings
The request must contain the following fields unless specifically identified as optional:
- UserSettingRequest - represents a request updating the settings of the current user. It includes the following fields:
- DefaultFilterVisibility - a Boolean value indicating whether filters on all columns are visible by default.
- DefaultSelectedFileType - the default viewer mode. See the DefaultSelectedFileType enumeration.
- EmailAddress - the user's email address in the format name@domain.extension.
- EmailPreference - the user's preference for email notifications when adding or deleting Users or Groups. See the EmailPreference enumeration.
- FirstName - the user's first name.
- ItemListPageLength - the default list length for all views in Relativity for the user.
- LastName - the user's last name
- SavedSearchDefaultsToPublic - a Boolean value indicating whether saved searches are public or private by default.
- SkipDefaultPreference - a Boolean value indicating whether the user advances to the next document in the queue that matches the defined view conditions when the user clicks Save and Next.
- LastModifiedOn - the date and time when the user was most recently modified. This field is only required if you want to restrict the update of a user to the date that it was last modified. The value must match the LastModifiedOn date for the user stored in Relativity. Otherwise, you receive a 409 error, indicating that the object has been modified.
{ "UserSettingRequest":{ "DefaultFilterVisibility":true, "DefaultSelectedFileType":"Default", "EmailAddress":"relativity.admin@kcura.com", "EmailPreference":"All", "FirstName":"Relativity", "ItemListPageLength":25, "LastName":"Admin", "SavedSearchDefaultsToPublic":false, "SkipDefaultPreference":false } }
The JSON response will look similar to the following:
{ "Actions": [ { "Name": "Delete", "Href": "Relativity.Users/workspace/-1/users/1018403", "Verb": "DELETE", "IsAvailable": true, "Reason": [] }, { "Name": "Update", "Href": "Relativity.Users/workspace/-1/users/1018403", "Verb": "PUT", "IsAvailable": true, "Reason": [] } ], "DefaultFilterVisibility": true, "DefaultSelectedFileType": "LongText", "EmailAddress": "email address", "EmailPreference": "All", "FirstName": "Updated First Name", "ItemListPageLength": 10, "LastName": "Updated Last Name", "Meta": { "Unsupported": [], "ReadOnly": [ "Client", "Email Address" ] }, "SavedSearchDefaultsToPublic": false, "SkipDefaultPreference": false }
Delete a user

You can programmatically remove a user from Relativity.
Note: Set the {{User ID}} variable to the Artifact ID of the user that you want to delete.
To do remove a user from Relativity, send a DELETE request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/users/{userID:int}
The body of the request is empty.
The response does not contain any data. Success or failure is indicated by the HTTP status code. For more information, see HTTP status codes in Relativity REST APIs.
Retrieve a list of active users in a workspace

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.
Note: Set the {{Workspace ID}} variable to the Artifact ID of the workspace that you want to query. Use -1 to retrieve users from the admin level.
To retrieve a list of active users in a workspace, send a GET request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/workspaces/{workspaceID:int}/active-users?{includeCurrentUser:int}&{enforceChoiceLimitForUI:bool}
The body of the request is empty.
The response is a list of objects containing the user information.
- ArtifactID - the Artifact ID of the user.
- Name - the full name of the user.
- Email - the email of the user.
The JSON response will look similar to the following:
{ "LoggedInUserID":9, "ActiveUsers":[ { "ArtifactID":1017952, "Name":"1, 1" }, { "ArtifactID":9, "Name":"Admin, Relativity" }, { "ArtifactID":777, "Name":"Service Account, Relativity" } ] }
Retrieve a list of all users in a workspace

You can retrieve all the users in a given workspace.
Note: Set the {{Workspace ID}} variable to the Artifact ID of the workspace that you want to query. Use -1 to retrieve users from the admin level.
To do retrieve a list of all users in a workspace, send a GET request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/workspaces/{workspaceID:int}/all-users?{includeDeleted:bool}
The body of the request is empty.
The response is a list of objects containing the user information.
- ArtifactID - the Artifact ID of the user.
- Name - the full name of the user.
- Email - the email of the user.
The JSON response will look similar to the following:
{ "LoggedInUserID":9, "ActiveUsers":[ { "ArtifactID":1017952, "Name":"1, 1" }, { "ArtifactID":9, "Name":"Admin, Relativity" }, { "ArtifactID":777, "Name":"Service Account, Relativity" } ] }
Retrieve a list of users that have Relativity access

You can retrieve the users in a given workspace that have Relativity access.
Note: Set the {{Workspace ID}} variable to the Artifact ID of the workspace that you want to query. Use -1 to retrieve users from the admin level.
To do retrieve a list of users in a workspace with Relativity access, send a GET request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/workspaces/{workspaceID:int}/users-with-access
The body of the request is empty.
The response is a list of objects containing the user information.
- ArtifactID - the Artifact ID of the user.
- Name - the full name of the user.
- Email - the email of the user.
The JSON response will look similar to the following:
{ "LoggedInUserID": 9, "ActiveUsers": [ { "ArtifactID": 9, "Name": "Admin, Relativity" }, { "ArtifactID": 777, "Name": "Service Account, Relativity" }, { "ArtifactID": 1017952, "Name": "1, 1" } ] }
Retrieve current user information in a workspace

You can retrieve information about the current user in a given workspace.
Note: Set the {{Workspace ID}} variable to the Artifact ID of the workspace that you want to query. Use -1 to retrieve users from the admin level.
To do retrieve the current user, send a GET request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/workspaces/{workspaceID:int}/users/me
The body of the request is empty.
The response is a list of objects containing the user information.
The JSON response will look similar to the following:
{ "FirstName": "Relativity", "LastName": "Admin", "ItemListPageLength": 25, "ShowFilters": true, "CreatedOn": "2007-01-01T00:00:00", "AclUserID": 9, "ArtifactID": 9, "Name": "Admin, Relativity" }
Query a list of users

You can provide conditions, sorting order and other information to query users in a given workspace
Note: Set the {{Workspace ID}} variable to the Artifact ID of the workspace that you want to query. Use -1 to retrieve users from the admin level.
To do query users in a given workspace, send a POST request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/workspaces/{workspaceID:int}/query-users
The JSON request should contain the following information:
- Query - a query request object containing conditions, sorting order, and other information for the query.
- Condition - conditional query statement.
- Sort - result sorting statement.
- Start - index of the first artifact in the returned result set.
- Length - number of items to return in the result, starting with index in the start parameter.
{ "Query":{ "Condition":"'User Type' IN ['Internal']", "Sort":[ { "FieldIdentifier":{ "Name":"FullName" }, "Direction":"Ascending" } ] }, "Start":0, "Length":25 }
The response contains the following fields unless specifically identified as optional:
- DataResults - a list of objects containing the the user information.
- ArtifactID - the Artifact ID of the user.
- FullName - the full name of the user.
- Email - the email of the user.
- ResultCount - the number of objects returned by the current query.
- TotalResultCount - the total number of objects in Relativity that meet the criteria of the query. Due to paging, this count may be larger than the number of objects returned in the ResultCount property.
- CurrentStartIndex - the index of the first artifact in the result set.
The JSON response will look similar to the following:
{ "DataResults":[ { "ArtifactID":1023278, "FullName":"Last Name, First Name", "Email":"email address 1" }, { "ArtifactID":1032861, "FullName":"Doe, Jane", "Email":"email address 2" }, { "ArtifactID":1032943, "FullName":"User, Test", "Email":"email address 3" } ], "ResultCount":3, "TotalResultCount":3, "CurrentStartIndex":0 }
Retrieve all the available types for the user

You can use the available-types endpoint to retrieve a list containing all the available choices for the user type.
To do retrieve all available types for user type, send a GET request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/users/available-types
The body of the request is empty.
The response is a list containing the user type identifiers.
- Name - the name of the user type.
- ArtifactID - the Artifact ID of the user type.
- Guids - an array of GUIDs used to identify the user type.
The JSON response will look similar to the following:
[ { "Name":"Internal", "ArtifactID":663, "Guids":[ ] }, { "Name":"External", "ArtifactID":672, "Guids":[ ] } ]
Query eligible groups to add users to

This queries for groups that are eligible for adding at least one of the specified users.
Note: Set the {{Workspace ID}} variable to the Artifact ID of the workspace that you want to query. Use -1 to retrieve users from the admin level.
To do query eligible groups to add users to, send a POST request to the following service URL:
<host>/Relativity.REST/api/Relativity-Identity/{versionNumber}/users/query-eligible-groups
The JSON request should contain the following information:
- Users - a list of users by ArtifactID
- Request - a query request object containing conditions, sorting order, and other information for the query.
- Condition - conditional query statement.
- Sorts - result sorting statement.
- Start - index of the first artifact in the returned result set.
- Length - number of items to return in the result, starting with index in the start parameter.
{ "Users":[ { "ArtifactID":9 } ], "Request":{ "Condition":"", "Sorts":[ { "FieldIdentifier":{ "Name":"Name" }, "Direction":"Ascending" } ] }, "Start":0, "Length":25 }
The JSON response will look similar to the following:
{ "TotalCount":6, "Objects":[ { "ArtifactID":1015025, "Values":[ ] }, { "ArtifactID":1015028, "Values":[ ] }, { "ArtifactID":1015029, "Values":[ ] }, { "ArtifactID":1015030, "Values":[ ] }, { "ArtifactID":1015026, "Values":[ ] }, { "ArtifactID":1015027, "Values":[ ] } ], "IDWindow":[ ], "CurrentStartIndex":0, "ResultCount":6, "ObjectType":{ "ArtifactID":1016185, "Name":"Group", "Guids":[ ], "ArtifactTypeID":3 }, "RankWindow":[ ], "Fields":[ ] }