How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Relativity

Relativity Identity Module v1 API

The Identity Module v1 API from Relativity — 62 operation(s) for identity module v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, 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.

Specification
OpenAPI 3.2.0
API Version
V1
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Resource Areas
1

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
Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.GetKeplerStatusAsync 1 param → 200
GET
/Relativity-Identity/v1/federated-instances
Read all Federated Instances
Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.ReadAllAsync 1 param body → 200
PUT
/Relativity-Identity/v1/federated-instances
Create a new Federated Instance
Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.CreateAsync 1 param body → 200
POST
/Relativity-Identity/v1/federated-instances
Update an existing Federated Instance
Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.UpdateAsync 1 param body → 200
GET
/Relativity-Identity/v1/federated-instances/{federatedInstanceName}
Read a Federated Instance
Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.ReadAsync 2 params body → 200
DELETE
/Relativity-Identity/v1/federated-instances/{federatedInstanceName}
Remove a Federated Instance from this Relativity instance
Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.DeleteAsync 2 params body → 200
GET
/Relativity-Identity/v1/OAuth2 Client Manager/GetKeplerStatusAsync
Ping Endpoint
Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.GetKeplerStatusAsync 1 param → 200
GET
/Relativity-Identity/v1/oauth2-clients
Read all OAuth2 Clients
Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.ReadAllAsync 1 param body → 200
POST
/Relativity-Identity/v1/oauth2-clients
Create a new OAuth2 Client.
Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.CreateAsync 1 param body → 200
PUT
/Relativity-Identity/v1/oauth2-clients
Save an OAuth2 Client.
Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.SaveAsync 1 param body → 200
GET
/Relativity-Identity/v1/oauth2-clients/{clientID}
Read an OAuth2 Client by Id.
Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.ReadAsync 2 params body → 200
DELETE
/Relativity-Identity/v1/oauth2-clients/{clientID}
Delete an OAuth2 Client.
Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.DeleteAsync 2 params body → 200
GET
/Relativity-Identity/v1/oauth2-clients/{clientID}/regenerate-secret
Generate a new secret for an OAuth2 Client. All previous secrets are immediately invalidated.
Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.RegenerateSecretAsync 2 params body → 200
GET
/Relativity-Identity/v1/Auth Provider Type Manager/GetKeplerStatusAsync
Ping Endpoint
Relativity.Identity.Server.V1.Services.Interfaces.IAuthProviderTypeManager.GetKeplerStatusAsync 1 param → 200
GET
/Relativity-Identity/v1/auth-provider-types
Retrieves all Provider Types
Relativity.Identity.Server.V1.Services.Interfaces.IAuthProviderTypeManager.ReadAllAsync 1 param body → 200
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.
Relativity.Identity.Server.V1.Services.Interfaces.IAuthProviderTypeManager.UpdateAsync 1 param body → 200
GET
/Relativity-Identity/v1/auth-provider-types/{name}
Retrieves a Provider Type
Relativity.Identity.Server.V1.Services.Interfaces.IAuthProviderTypeManager.ReadAsync 2 params body → 200
GET
/Relativity-Identity/v1/Group Manager/GetKeplerStatusAsync
Ping Endpoint
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.GetKeplerStatusAsync 1 param → 200
POST
/Relativity-Identity/v1/groups
Adds a user group to Relativity.
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.CreateAsync 1 param body → 200
GET
/Relativity-Identity/v1/groups/{groupID}?{includeMetadata}&{includeActions}
Retrieves advanced metadata for a user group, including its name, associated client, and other properties.
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.ReadAsync 4 params body → 200
PUT
/Relativity-Identity/v1/groups/{groupID}
Modifies the properties of a user group.
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.UpdateAsync 2 params body → 200
DELETE
/Relativity-Identity/v1/groups/{groupID}
Deletes a user group.
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.DeleteAsync 2 params body → 200
POST
/Relativity-Identity/v1/groups/{groupID}/query-members
Retrieves the list of users in a given group.
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.QueryMembersAsync 2 params body → 200
POST
/Relativity-Identity/v1/groups/{groupID}/members
Adds a list of users to a given group.
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.AddMembersAsync 2 params body → 200
DELETE
/Relativity-Identity/v1/groups/{groupID}/members
Removes a list of users from a given group.
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.RemoveMembersAsync 2 params body → 200
POST
/Relativity-Identity/v1/groups/members
[Public] IGroupManager
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.MassAddUsersToGroupsAsync 1 param body → 200
DELETE
/Relativity-Identity/v1/groups/members
[Public] IGroupManager
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.MassRemoveUsersFromGroupsAsync 1 param body → 200
POST
/Relativity-Identity/v1/groups/eligible-clients/query
Query for Clients that are valid for the client property on group
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.QueryEligibleClients 1 param body → 200
POST
/Relativity-Identity/v1/groups/{groupID}/eligible-members/query
Query for Users that are eligible to be members of a group.
Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.QueryEligibleUsersToAdd 2 params body → 200
GET
/Relativity-Identity/v1/Login Profile Manager/GetKeplerStatusAsync
Ping Endpoint
Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.GetKeplerStatusAsync 1 param → 200
GET
/Relativity-Identity/v1/users/{userID}/login-profile
Get a Login Method Profile for a given user.
Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.GetLoginProfileAsync 2 params body → 200
POST
/Relativity-Identity/v1/users/{userID}/login-profile
Save a Login Method profile.
Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.UpdateLoginProfileAsync 2 params body → 200
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)
Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.SetPasswordAsync 2 params body → 200
POST
/Relativity-Identity/v1/users/{userID}/Invitation
Sends an Invitation Workflow e-mail to the specified user.
Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.SendInvitationAsync 2 params body → 200
POST
/Relativity-Identity/v1/Users/bulk-invitation
Sends an Invitation Workflow e-mail to each specified user.
Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.SendBulkInvitationAsync 1 param body → 200
POST
/Relativity-Identity/v1/users/bulk-invitation/verify
Verifies an Invitation Workflow without sending an email.
Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.VerifyBulkInvitationAsync 1 param body → 200
GET
/Relativity-Identity/v1/auth-profile/global
Read the Global Auth Profile from the system
Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.GetGlobalProfileAsync 1 param body → 200
PUT
/Relativity-Identity/v1/auth-profile
Save an Auth Profile
Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.SaveProfileAsync 1 param body → 200
GET
/Relativity-Identity/v1/Permission Manager/GetKeplerStatusAsync
Ping Endpoint
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetKeplerStatusAsync 1 param → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/permissions
Get Workspace Group Permissions.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetWorkspaceGroupPermissionsAsync 3 params body → 200
PUT
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/permissions
Set Workspace Group Permissions.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.SetWorkspaceGroupPermissionsAsync 3 params body → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/artifacts/{artifactID}/permissions
Get Item Group Permissions.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetItemGroupPermissionsAsync 4 params body → 200
PUT
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/artifacts/{artifactID}/permissions
Set Item Group Permissions.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.SetItemGroupPermissionsAsync 4 params body → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/{artifactID}/security
Get Item Level Security settings for a given ArtifactID.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetItemLevelSecurityAsync 3 params body → 200
PUT
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/{artifactID}/security
Set Item Level Security settings for a given ArtifactID.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.SetItemLevelSecurityAsync 3 params body → 200
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…
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetItemLevelSecurityListAsync 2 params body → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/members
Get Workspace Group Users.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetWorkspaceGroupUsersAsync 3 params body → 200
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
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.IsUserInWorkspaceGroupAsync 4 params body → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/artifacts/{artifactID}/members
Get Item Group Users.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetItemGroupUsersAsync 4 params body → 200
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/permissions
Asynchronously create a new permission.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.CreateSingleAsync 2 params body → 200
PUT
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/permissions
Asynchronously updates a Permission.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.UpdateSingleAsync 2 params body → 200
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/query-permissions?{length}
Asynchronously queries for a subset of a collection of Permission instances.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.QueryAsync 3 params body → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/query-permissions?{length}&{queryToken}&{start}
Asynchronously queries for a subset of a collection of Permission instances.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.QueryAsync 5 params body → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/permissions/{permissionID}
Asynchronously read a single Permission instance.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.ReadSingleAsync 3 params body → 200
DELETE
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/permissions/{permissionID}
Asynchronously delets a Permission.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.DeleteSingleAsync 3 params body → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/has-access
Determines if the current user has access to workspace.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.HasAccessToWorkspaceAsync 2 params body → 200
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/list-permissions
Indicates a given permission is selected. (ArtifactTypeID)
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetPermissionSelectedAsync 2 params body → 200
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)
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetPermissionSelectedAsync 3 params body → 200
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…
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetPermissionSelectedListAsync 2 params body → 200
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/list-permissions
Indicates a given permission is selected. (ArtifactTypeID for a given Group)
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetPermissionSelectedForGroupAsync 3 params body → 200
POST
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/Admin/list-permissions
Indicates if a given admin permission is selected.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetAdminOperationPermissionSelectedListAsync 2 params body → 200
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)
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetPermissionSelectedForGroupAsync 4 params body → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupArtifactID}/tab-visibility
Get a list of tabs for the group and the tab visibility state.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetGroupTabVisibilityAsync 3 params body → 200
PUT
/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupArtifactID}/tab-visibility
Update the tab visibility state for a group.
Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.SetGroupTabVisibilityAsync 3 params body → 200
GET
/Relativity-Identity/v1/User Manager/GetKeplerStatusAsync
Ping Endpoint
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.GetKeplerStatusAsync 1 param → 200
POST
/Relativity-Identity/v1/users/{userID}/query-groups
[Public] IUserManager
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.QueryGroupsByUserAsync 2 params body → 200
POST
/Relativity-Identity/v1/users/query-eligible-groups
Query for Groups that are eligible for adding at least one of specified users.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.QueryEligibleGroupsToAddUsersToAsync 1 param body → 200
POST
/Relativity-Identity/v1/users
Adds a single user to Relativity.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.CreateAsync 1 param body → 200
GET
/Relativity-Identity/v1/users/{userID}?{includeMetadata}&{includeActions}
Retrieves advanced metadata for a user, including their Relativity access, name, email, and other properties.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.ReadAsync 4 params body → 200
GET
/Relativity-Identity/v1/users/me/settings?{includeMetadata}?{includeActions}
Retrieves settings for the current user, including their name, email, and other properties.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.ReadSettingsAsync 3 params body → 200
PUT
/Relativity-Identity/v1/users/{userID}
Modifies the properties of a user.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.UpdateAsync 2 params body → 200
DELETE
/Relativity-Identity/v1/users/{userID}
Deletes a user.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.DeleteAsync 2 params body → 200
PUT
/Relativity-Identity/v1/users/me/settings
Modifies the user setting properties of the current user.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.UpdateSettingsAsync 1 param body → 200
GET
/Relativity-Identity/v1/users/available-types
Gets all possible types for the User
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.GetAvailableTypesAsync 1 param body → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceID}/users
Gets a list of all users and their information for a given workspace.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.RetrieveAll 2 params body → 200
POST
/Relativity-Identity/v1/workspaces/{workspaceID}/query-users
Gets a list of users and their information, and supports filtering, ordering, and paging these results.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.RetrieveUsersBy 2 params body → 200
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.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.RetrieveCurrentAsync 2 params body → 200
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.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.ReadAllUsersAsync 3 params body → 200
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.
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.ReadActiveUsersAsync 4 params body → 200
GET
/Relativity-Identity/v1/workspaces/{workspaceID}/users-with-access
[Public] IUserManager
Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.RetrieveAllWithRelativityAccessAsync 2 params body → 200

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are QueryEligibleGroupsToAddUsersToAsync (4 properties), QueryEligibleClients (3 properties), QueryEligibleUsersToAdd (3 properties), QueryGroupsByUserAsync (3 properties). Each schema is shown below with its type and property counts.

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
RetrieveUsersBy
object
Gets a list of users and their information, and supports filtering, ordering, and paging these results.
3 properties 3 required
GetPermissionSelectedForGroupAsync
object
Indicates a given permission is selected. (ArtifactTypeID for a given Group)
1 property 1 required
DeleteAsync
Remove a Federated Instance from this Relativity instance
SaveProfileAsync
object
Save an Auth Profile
1 property 1 required
MassAddUsersToGroupsAsync
object
2 properties 2 required
VerifyBulkInvitationAsync
object
Verifies an Invitation Workflow without sending an email.
1 property 1 required
RetrieveAllWithRelativityAccessAsync
SetWorkspaceGroupPermissionsAsync
object
Set Workspace Group Permissions.
1 property 1 required
ReadAllAsync
Read all Federated Instances
QueryAsync
object
Asynchronously queries for a subset of a collection of Permission instances.
1 property 1 required
ReadSettingsAsync
Retrieves settings for the current user, including their name, email, and other properties.
RetrieveAll
Gets a list of all users and their information for a given workspace.
AddMembersAsync
object
Adds a list of users to a given group.
1 property 1 required
QueryEligibleGroupsToAddUsersToAsync
object
Query for Groups that are eligible for adding at least one of specified users.
4 properties 4 required
GetPermissionSelectedAsync
object
Indicates a given permission is selected. (ArtifactTypeID)
1 property 1 required
RetrieveCurrentAsync
Asynchronously retrieves the current user in the specified workspace. NOTE: User Artifact ID may differ for the same user in different workspaces.
SetGroupTabVisibilityAsync
object
Update the tab visibility state for a group.
1 property 1 required
GetItemGroupUsersAsync
Get Item Group Users.
CreateAsync
object
Create a new Federated Instance
1 property 1 required
SendInvitationAsync
Sends an Invitation Workflow e-mail to the specified user.
ReadAllUsersAsync
Asynchronously retrieves a list of all users in a workspace, including administrators and (optional) deleted users.
ReadAsync
Read a Federated Instance
QueryEligibleClients
object
Query for Clients that are valid for the client property on group
3 properties 3 required
GetAdminOperationPermissionSelectedListAsync
object
Indicates if a given admin permission is selected.
1 property 1 required
MassRemoveUsersFromGroupsAsync
object
2 properties 2 required
RegenerateSecretAsync
Generate a new secret for an OAuth2 Client. All previous secrets are immediately invalidated.
ReadSingleAsync
Asynchronously read a single Permission instance.
RemoveMembersAsync
object
Removes a list of users from a given group.
1 property 1 required
QueryGroupsByUserAsync
object
3 properties 3 required
GetItemGroupPermissionsAsync
Get Item Group Permissions.
SetItemLevelSecurityAsync
object
Set Item Level Security settings for a given ArtifactID.
1 property 1 required
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
GetItemLevelSecurityAsync
Get Item Level Security settings for a given ArtifactID.
GetWorkspaceGroupPermissionsAsync
Get Workspace Group Permissions.
GetLoginProfileAsync
Get a Login Method Profile for a given user.
QueryEligibleUsersToAdd
object
Query for Users that are eligible to be members of a group.
3 properties 3 required
UpdateLoginProfileAsync
object
Save a Login Method profile.
1 property 1 required
GetWorkspaceGroupUsersAsync
Get Workspace Group Users.
UpdateAsync
object
Update an existing Federated Instance
1 property 1 required
UpdateSingleAsync
object
Asynchronously updates a Permission.
1 property 1 required
UpdateSettingsAsync
object
Modifies the user setting properties of the current user.
1 property 1 required
IsUserInWorkspaceGroupAsync
Determines if the given user is a member of the given workspace group
SetItemGroupPermissionsAsync
object
Set Item Group Permissions.
1 property 1 required
SendBulkInvitationAsync
object
Sends an Invitation Workflow e-mail to each specified user.
1 property 1 required
GetAvailableTypesAsync
Gets all possible types for the User
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
SaveAsync
object
Save an OAuth2 Client.
1 property 1 required
HasAccessToWorkspaceAsync
Determines if the current user has access to workspace.
GetGroupTabVisibilityAsync
Get a list of tabs for the group and the tab visibility state.
DeleteSingleAsync
Asynchronously delets a Permission.
GetGlobalProfileAsync
Read the Global Auth Profile from the system
CreateSingleAsync
object
Asynchronously create a new permission.
1 property 1 required
QueryMembersAsync
object
Retrieves the list of users in a given group.
3 properties 3 required
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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

relativity-identity-module-v1-api-openapi.yml Raw ↑

Other APIs Relativity publishes across the network.

Relativity AnnotationService API
AE Profile APIs.io
Relativity ArchiveJobs API
AE Profile APIs.io
Relativity ARM Module v1 API
AE Profile APIs.io
Relativity ARM Module v3 API
AE Profile APIs.io
Relativity BillableSummaryReports API
AE Profile APIs.io
Relativity BillingConfiguration API
AE Profile APIs.io
Relativity BillingInsights API
AE Profile APIs.io
Relativity Client Side Libraries Module API
AE Profile APIs.io
Relativity ColdStorage API
AE Profile APIs.io
Relativity CollectAPI API
AE Profile APIs.io
Relativity Conceptual Analytics v1 API
AE Profile APIs.io
Relativity Directory API
AE Profile APIs.io
#Identity Module v1
← Back to R APIs
API Details
ID
relativity:relativity-identity-module-v1-api
Base URL
https://{host}/Relativity.REST/api/relativity-object-model/v1
Docs
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
Provider
Relativity
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=relativity-identity-module-v1-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/relativity-identity-module-v1-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Relativity Identity Module v1 API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.