Relativity Identity Module v1 API
The Identity Module v1 API from Relativity — 62 operation(s) for identity module v1.
Relativity Identity Module v1 API is one of 51 APIs that Relativity publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Identity Module v1. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, rate-limit docs, and a getting-started guide.
This API exposes 80 operations across 62 paths, and defines 55 schemas. It is described by OpenAPI 3.0.1, at version V1.
Requests are made against a single base URL, /Relativity.REST/api.
80 operations
62 paths
55 schemas
7 DELETE35 GET26 POST12 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 80
Across 62 paths, the API surfaces 80 operations — 7 DELETE, 35 GET, 26 POST, 12 PUT. Each is listed below with its method, path, parameters, and response codes.
Identity Module v1 80
GET
/Relativity-Identity/v1/Federated Instance Manager/GetKeplerStatusAsync
Ping Endpoint
GET
/Relativity-Identity/v1/federated-instances
Read all Federated Instances
PUT
/Relativity-Identity/v1/federated-instances
Create a new Federated Instance
POST
/Relativity-Identity/v1/federated-instances
Update an existing Federated Instance
GET
/Relativity-Identity/v1/federated-instances/{federatedInstanceName}
Read a Federated Instance
DELETE
/Relativity-Identity/v1/federated-instances/{federatedInstanceName}
Remove a Federated Instance from this Relativity instance
GET
/Relativity-Identity/v1/OAuth2 Client Manager/GetKeplerStatusAsync
Ping Endpoint
GET
/Relativity-Identity/v1/oauth2-clients
Read all OAuth2 Clients
POST
/Relativity-Identity/v1/oauth2-clients
Create a new OAuth2 Client.
PUT
/Relativity-Identity/v1/oauth2-clients
Save an OAuth2 Client.
GET
/Relativity-Identity/v1/oauth2-clients/{clientID}
Read an OAuth2 Client by Id.
DELETE
/Relativity-Identity/v1/oauth2-clients/{clientID}
Delete an OAuth2 Client.
GET
/Relativity-Identity/v1/oauth2-clients/{clientID}/regenerate-secret
Generate a new secret for an OAuth2 Client. All previous secrets are immediately invalidated.
GET
/Relativity-Identity/v1/Auth Provider Type Manager/GetKeplerStatusAsync
Ping Endpoint
GET
/Relativity-Identity/v1/auth-provider-types
Retrieves all Provider Types
POST
/Relativity-Identity/v1/auth-provider-types
Updates a Provider Type, allowing you to enable or disable Provider Types in the environment. Disabling a Provider Type prevents all users from using that protocol during login.
GET
/Relativity-Identity/v1/auth-provider-types/{name}
Retrieves a Provider Type
GET
/Relativity-Identity/v1/Group Manager/GetKeplerStatusAsync
Ping Endpoint
POST
/Relativity-Identity/v1/groups
Adds a user group to Relativity.
GET
/Relativity-Identity/v1/groups/{groupID}?{includeMetadata}&{includeActions}
Retrieves advanced metadata for a user group, including its name, associated client, and other properties.
PUT
/Relativity-Identity/v1/groups/{groupID}
Modifies the properties of a user group.
DELETE
/Relativity-Identity/v1/groups/{groupID}
Deletes a user group.
POST
/Relativity-Identity/v1/groups/{groupID}/query-members
Retrieves the list of users in a given group.
POST
/Relativity-Identity/v1/groups/{groupID}/members
Adds a list of users to a given group.
DELETE
/Relativity-Identity/v1/groups/{groupID}/members
Removes a list of users from a given group.
POST
/Relativity-Identity/v1/groups/members
[Public] IGroupManager
DELETE
/Relativity-Identity/v1/groups/members
[Public] IGroupManager
POST
/Relativity-Identity/v1/groups/eligible-clients/query
Query for Clients that are valid for the client property on group
POST
/Relativity-Identity/v1/groups/{groupID}/eligible-members/query
Query for Users that are eligible to be members of a group.
GET
/Relativity-Identity/v1/Login Profile Manager/GetKeplerStatusAsync
Ping Endpoint
GET
/Relativity-Identity/v1/users/{userID}/login-profile
Get a Login Method Profile for a given user.
POST
/Relativity-Identity/v1/users/{userID}/login-profile
Save a Login Method profile.
PUT
/Relativity-Identity/v1/users/{userID}/login-profile/set/password
Explicitly set a user's password. Note that admins are not allowed to reset Relativity users' passwords by default. (see Remarks for more information)
POST
/Relativity-Identity/v1/users/{userID}/Invitation
Sends an Invitation Workflow e-mail to the specified user.
POST
/Relativity-Identity/v1/Users/bulk-invitation
Sends an Invitation Workflow e-mail to each specified user.
POST
/Relativity-Identity/v1/users/bulk-invitation/verify
Verifies an Invitation Workflow without sending an email.
GET
/Relativity-Identity/v1/auth-profile/global
Read the Global Auth Profile from the system
PUT
/Relativity-Identity/v1/auth-profile
Save an Auth Profile
GET
/Relativity-Identity/v1/Permission Manager/GetKeplerStatusAsync
Ping Endpoint
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/permissions
Get Workspace Group Permissions.
PUT
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/permissions
Set Workspace Group Permissions.
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/artifacts/{artifactID}/permissions
Get Item Group Permissions.
PUT
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/artifacts/{artifactID}/permissions
Set Item Group Permissions.
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/{artifactID}/security
Get Item Level Security settings for a given ArtifactID.
PUT
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/{artifactID}/security
Set Item Level Security settings for a given ArtifactID.
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/list-security
Returns a dictionary of item-level security settings objects for the specified Relativity artifacts. Inputs include the workspace ArtifactID and a collection of ArtifactIDs. For admin artifacts, spec…
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/members
Get Workspace Group Users.
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/members/{userID}/is-member
Determines if the given user is a member of the given workspace group
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/artifacts/{artifactID}/members
Get Item Group Users.
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/permissions
Asynchronously create a new permission.
PUT
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/permissions
Asynchronously updates a Permission.
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/query-permissions?{length}
Asynchronously queries for a subset of a collection of Permission instances.
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/query-permissions?{length}&{queryToken}&{start}
Asynchronously queries for a subset of a collection of Permission instances.
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/permissions/{permissionID}
Asynchronously read a single Permission instance.
DELETE
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/permissions/{permissionID}
Asynchronously delets a Permission.
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/has-access
Determines if the current user has access to workspace.
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/list-permissions
Indicates a given permission is selected. (ArtifactTypeID)
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/{artifactID}/list-permissions
Indicates a given permission is selected. (ItemLevelSecurity on an ArtifactID of a given permission ArtifactTypeID)
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/list-permissions
Returns the current user’s permission to the specified relativity artifacts as a dictionary that maps the ArtifactID to the permissions values. Inputs include the workspace ArtifactID, a collection o…
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/list-permissions
Indicates a given permission is selected. (ArtifactTypeID for a given Group)
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/Admin/list-permissions
Indicates if a given admin permission is selected.
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/artifacts/{artifactID}/list-permissions
Indicates a given permission is selected. (ItemLevelSecurity on an ArtifactID of a given permission ArtifactTypeID for a given Group)
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupArtifactID}/tab-visibility
Get a list of tabs for the group and the tab visibility state.
PUT
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupArtifactID}/tab-visibility
Update the tab visibility state for a group.
GET
/Relativity-Identity/v1/User Manager/GetKeplerStatusAsync
Ping Endpoint
POST
/Relativity-Identity/v1/users/{userID}/query-groups
[Public] IUserManager
POST
/Relativity-Identity/v1/users/query-eligible-groups
Query for Groups that are eligible for adding at least one of specified users.
POST
/Relativity-Identity/v1/users
Adds a single user to Relativity.
GET
/Relativity-Identity/v1/users/{userID}?{includeMetadata}&{includeActions}
Retrieves advanced metadata for a user, including their Relativity access, name, email, and other properties.
GET
/Relativity-Identity/v1/users/me/settings?{includeMetadata}?{includeActions}
Retrieves settings for the current user, including their name, email, and other properties.
PUT
/Relativity-Identity/v1/users/{userID}
Modifies the properties of a user.
DELETE
/Relativity-Identity/v1/users/{userID}
Deletes a user.
PUT
/Relativity-Identity/v1/users/me/settings
Modifies the user setting properties of the current user.
GET
/Relativity-Identity/v1/users/available-types
Gets all possible types for the User
GET
/Relativity-Identity/v1/workspaces/{workspaceID}/users
Gets a list of all users and their information for a given workspace.
POST
/Relativity-Identity/v1/workspaces/{workspaceID}/query-users
Gets a list of users and their information, and supports filtering, ordering, and paging these results.
GET
/Relativity-Identity/v1/workspaces/{workspaceID}/users/me
Asynchronously retrieves the current user in the specified workspace. NOTE: User Artifact ID may differ for the same user in different workspaces.
GET
/Relativity-Identity/v1/workspaces/{workspaceID}/all-users?{includeDeleted}
Asynchronously retrieves a list of all users in a workspace, including administrators and (optional) deleted users.
GET
/Relativity-Identity/v1/workspaces/{workspaceID}/active-users?{includeCurrentUser}&{enforceChoiceLimitForUI}
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.
GET
/Relativity-Identity/v1/workspaces/{workspaceID}/users-with-access
[Public] IUserManager
Schemas 55
The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are QueryEligibleGroupsToAddUsersToAsync (4 properties), QueryGroupsByUserAsync (3 properties), QueryEligibleUsersToAdd (3 properties), QueryMembersAsync (3 properties). Each schema is shown below with its type and property counts.
DeleteAsync
Remove a Federated Instance from this Relativity instance
VerifyBulkInvitationAsync
object
Verifies an Invitation Workflow without sending an email.
1 property
1 required
ReadAsync
Read a Federated Instance
RemoveMembersAsync
object
Removes a list of users from a given group.
1 property
1 required
SetItemLevelSecurityAsync
object
Set Item Level Security settings for a given ArtifactID.
1 property
1 required
GetAdminOperationPermissionSelectedListAsync
object
Indicates if a given admin permission is selected.
1 property
1 required
QueryEligibleGroupsToAddUsersToAsync
object
Query for Groups that are eligible for adding at least one of specified users.
4 properties
4 required
GetAvailableTypesAsync
Gets all possible types for the User
SaveProfileAsync
object
Save an Auth Profile
1 property
1 required
QueryEligibleUsersToAdd
object
Query for Users that are eligible to be members of a group.
3 properties
3 required
ReadAllAsync
Read all Federated Instances
RegenerateSecretAsync
Generate a new secret for an OAuth2 Client. All previous secrets are immediately invalidated.
GetItemLevelSecurityAsync
Get Item Level Security settings for a given ArtifactID.
ReadSettingsAsync
Retrieves settings for the current user, including their name, email, and other properties.
MassAddUsersToGroupsAsync
object
2 properties
2 required
GetWorkspaceGroupUsersAsync
Get Workspace Group Users.
SaveAsync
object
Save an OAuth2 Client.
1 property
1 required
QueryMembersAsync
object
Retrieves the list of users in a given group.
3 properties
3 required
GetGlobalProfileAsync
Read the Global Auth Profile from the system
RetrieveCurrentAsync
Asynchronously retrieves the current user in the specified workspace. NOTE: User Artifact ID may differ for the same user in different workspaces.
ReadActiveUsersAsync
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 retu…
GetItemGroupPermissionsAsync
Get Item Group Permissions.
SetWorkspaceGroupPermissionsAsync
object
Set Workspace Group Permissions.
1 property
1 required
HasAccessToWorkspaceAsync
Determines if the current user has access to workspace.
AddMembersAsync
object
Adds a list of users to a given group.
1 property
1 required
UpdateSettingsAsync
object
Modifies the user setting properties of the current user.
1 property
1 required
QueryGroupsByUserAsync
object
3 properties
3 required
QueryEligibleClients
object
Query for Clients that are valid for the client property on group
3 properties
3 required
GetGroupTabVisibilityAsync
Get a list of tabs for the group and the tab visibility state.
UpdateSingleAsync
object
Asynchronously updates a Permission.
1 property
1 required
GetPermissionSelectedAsync
object
Indicates a given permission is selected. (ArtifactTypeID)
1 property
1 required
ReadSingleAsync
Asynchronously read a single Permission instance.
UpdateLoginProfileAsync
object
Save a Login Method profile.
1 property
1 required
SendBulkInvitationAsync
object
Sends an Invitation Workflow e-mail to each specified user.
1 property
1 required
MassRemoveUsersFromGroupsAsync
object
2 properties
2 required
IsUserInWorkspaceGroupAsync
Determines if the given user is a member of the given workspace group
GetPermissionSelectedForGroupAsync
object
Indicates a given permission is selected. (ArtifactTypeID for a given Group)
1 property
1 required
GetLoginProfileAsync
Get a Login Method Profile for a given user.
UpdateAsync
object
Update an existing Federated Instance
1 property
1 required
QueryAsync
object
Asynchronously queries for a subset of a collection of Permission instances.
1 property
1 required
RetrieveAll
Gets a list of all users and their information for a given workspace.
RetrieveUsersBy
object
Gets a list of users and their information, and supports filtering, ordering, and paging these results.
3 properties
3 required
CreateAsync
object
Create a new Federated Instance
1 property
1 required
DeleteSingleAsync
Asynchronously delets a Permission.
GetPermissionSelectedListAsync
object
Returns the current user’s permission to the specified relativity artifacts as a dictionary that maps the ArtifactID to the permissions values. Inputs include…
2 properties
2 required
GetItemGroupUsersAsync
Get Item Group Users.
RetrieveAllWithRelativityAccessAsync
SendInvitationAsync
Sends an Invitation Workflow e-mail to the specified user.
CreateSingleAsync
object
Asynchronously create a new permission.
1 property
1 required
ReadAllUsersAsync
Asynchronously retrieves a list of all users in a workspace, including administrators and (optional) deleted users.
SetGroupTabVisibilityAsync
object
Update the tab visibility state for a group.
1 property
1 required
GetItemLevelSecurityListAsync
object
Returns a dictionary of item-level security settings objects for the specified Relativity artifacts. Inputs include the workspace ArtifactID and a collection o…
1 property
1 required
SetItemGroupPermissionsAsync
object
Set Item Group Permissions.
1 property
1 required
GetWorkspaceGroupPermissionsAsync
Get Workspace Group Permissions.
SetPasswordAsync
object
Explicitly set a user's password. Note that admins are not allowed to reset Relativity users' passwords by default. (see Remarks for more information)
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Relativity 12
Other APIs Relativity publishes across the network.
Relativity AnnotationService API
Relativity ArchiveJobs API
Relativity ARM Module v1 API
Relativity ARM Module v3 API
Relativity BillableSummaryReports API
Relativity BillingConfiguration API
Relativity BillingInsights API
Relativity Client Side Libraries Module API
Relativity ColdStorage API
Relativity CollectAPI API
Relativity Conceptual Analytics v1 API
Relativity Directory API
#Identity Module v1