Relativity

Relativity Identity Module v1 API

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

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 80

GET /Relativity-Identity/v1/Federated Instance Manager/GetKeplerStatusAsync Relativity identity server V1 services interfaces IFederated instance manager… #
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 Relativity identity server V1 services interfaces IO auth2 client manager get… #
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. #
GET /Relativity-Identity/v1/Auth Provider Type Manager/GetKeplerStatusAsync Relativity identity server V1 services interfaces IAuth provider type manager… #
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… #
GET /Relativity-Identity/v1/auth-provider-types/{name} Retrieves a Provider Type #
GET /Relativity-Identity/v1/Group Manager/GetKeplerStatusAsync Relativity identity server V1 services interfaces IGroup manager get kepler… #
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… #
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 Relativity identity server V1 services interfaces IGroup manager mass add users… #
DELETE /Relativity-Identity/v1/groups/members Relativity identity server V1 services interfaces IGroup manager mass remove… #
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 Relativity identity server V1 services interfaces ILogin profile manager get… #
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. #
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 Relativity identity server V1 services interfaces IPermission manager get… #
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… #
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. #
POST /Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/list-permissions Returns the current user’s permission to the specified relativity artifacts as… #
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. #
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 Relativity identity server V1 services interfaces IUser manager get kepler… #
POST /Relativity-Identity/v1/users/{userID}/query-groups Relativity identity server V1 services interfaces IUser manager query groups by… #
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… #
GET /Relativity-Identity/v1/users/me/settings?{includeMetadata}?{includeActions} Retrieves settings for the current user, including their name, email, and other… #
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… #
GET /Relativity-Identity/v1/workspaces/{workspaceID}/users/me Asynchronously retrieves the current user in the specified workspace. #
GET /Relativity-Identity/v1/workspaces/{workspaceID}/all-users?{includeDeleted} Asynchronously retrieves a list of all users in a workspace, including… #
GET /Relativity-Identity/v1/workspaces/{workspaceID}/active-users?{includeCurrentUser}&{enforceChoiceLimitForUI} Asynchronously retrieves a list of all active users in a workspace. #
GET /Relativity-Identity/v1/workspaces/{workspaceID}/users-with-access Relativity identity server V1 services interfaces IUser manager retrieve all… #

Documentation

📖
Documentation
https://platform.relativity.com/RelativityOne/Content/REST_API/REST_API.htm
📖
RateLimits
https://artifacts.apis.io/relativity/rate-limits/relativity-rate-limits.yml
📖
Documentation
https://platform.relativity.com/RelativityOne/Content/Relativity_Platform/Platform_APIs.htm
📖
GettingStarted
https://platform.relativity.com/RelativityOne/Content/Getting_Started/Basic_REST_API_concepts.htm
📖
Documentation
https://help.relativity.com/RelativityOne/Content/Management_Console/Cost_Explorer.htm

Specifications

⚙
OpenAPI
https://artifacts.apis.io/relativity/openapi/relativity-identity-module-v1-api-openapi.yml

Other Resources

🔗
Plans
https://artifacts.apis.io/relativity/plans/relativity-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/relativity/finops/relativity-finops.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/relativity:relativity-identity-module-v1-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

relativity-identity-module-v1-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Relativity.Identity Identity Module v1 API
  description: Relativity.Identity Kepler Module
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:


# --- truncated at 32 KB (151 KB total) ---
# Full source: https://artifacts.apis.io/relativity/openapi/relativity-identity-module-v1-api-openapi.yml