{ "openapi": "3.0.1", "info": { "title": "Relativity.Identity", "description": "Relativity.Identity Kepler Module", "version": "V1" }, "servers": [ { "url": "/Relativity.REST/api", "description": "The URL prefix for all Kepler services" } ], "paths": { "/Relativity-Identity/v1/Federated Instance Manager/GetKeplerStatusAsync": { "get": { "tags": [ "Identity Module v1" ], "description": "Ping Endpoint", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.GetKeplerStatusAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/federated-instances": { "get": { "tags": [ "Identity Module v1" ], "summary": "Read all Federated Instances", "description": "[Public] IFederatedInstanceManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.ReadAllAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Read all Federated Instances", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadAllAsync" } } }, "required": true }, "responses": { "200": { "description": "A collection of all Federated Instances the caller has permission to see" } } }, "put": { "tags": [ "Identity Module v1" ], "summary": "Create a new Federated Instance", "description": "[Public] IFederatedInstanceManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.CreateAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Create a new Federated Instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } }, "post": { "tags": [ "Identity Module v1" ], "summary": "Update an existing Federated Instance", "description": "[Public] IFederatedInstanceManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.UpdateAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Update an existing Federated Instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/federated-instances/{federatedInstanceName}": { "get": { "tags": [ "Identity Module v1" ], "summary": "Read a Federated Instance", "description": "[Public] IFederatedInstanceManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/federatedInstanceName" } ], "requestBody": { "description": "Read a Federated Instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadAsync" } } }, "required": true }, "responses": { "200": { "description": "The request Federated Instance" } } }, "delete": { "tags": [ "Identity Module v1" ], "summary": "Remove a Federated Instance from this Relativity instance", "description": "[Public] IFederatedInstanceManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager.DeleteAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/federatedInstanceName" } ], "requestBody": { "description": "Remove a Federated Instance from this Relativity instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/OAuth2 Client Manager/GetKeplerStatusAsync": { "get": { "tags": [ "Identity Module v1" ], "description": "Ping Endpoint", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.GetKeplerStatusAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/oauth2-clients": { "get": { "tags": [ "Identity Module v1" ], "summary": "Read all OAuth2 Clients", "description": "[Public] IOAuth2ClientManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.ReadAllAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Read all OAuth2 Clients", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadAllAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } }, "post": { "tags": [ "Identity Module v1" ], "summary": "Create a new OAuth2 Client.", "description": "[Public] IOAuth2ClientManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.CreateAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Create a new OAuth2 Client.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } }, "put": { "tags": [ "Identity Module v1" ], "summary": "Save an OAuth2 Client.", "description": "[Public] IOAuth2ClientManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.SaveAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Save an OAuth2 Client.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/oauth2-clients/{clientID}": { "get": { "tags": [ "Identity Module v1" ], "summary": "Read an OAuth2 Client by Id.", "description": "[Public] IOAuth2ClientManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/clientID" } ], "requestBody": { "description": "Read an OAuth2 Client by Id.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadAsync" } } }, "required": true }, "responses": { "200": { "description": "The requested profile" } } }, "delete": { "tags": [ "Identity Module v1" ], "summary": "Delete an OAuth2 Client.", "description": "[Public] IOAuth2ClientManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.DeleteAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/clientID" } ], "requestBody": { "description": "Delete an OAuth2 Client.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/oauth2-clients/{clientID}/regenerate-secret": { "get": { "tags": [ "Identity Module v1" ], "summary": "Generate a new secret for an OAuth2 Client. All previous secrets are immediately invalidated.", "description": "[Public] IOAuth2ClientManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager.RegenerateSecretAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/clientID" } ], "requestBody": { "description": "Generate a new secret for an OAuth2 Client. All previous secrets are immediately invalidated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegenerateSecretAsync" } } }, "required": true }, "responses": { "200": { "description": "The new secret." } } } }, "/Relativity-Identity/v1/Auth Provider Type Manager/GetKeplerStatusAsync": { "get": { "tags": [ "Identity Module v1" ], "description": "Ping Endpoint", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IAuthProviderTypeManager.GetKeplerStatusAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/auth-provider-types": { "get": { "tags": [ "Identity Module v1" ], "summary": "Retrieves all Provider Types", "description": "[Public] IAuthProviderTypeManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IAuthProviderTypeManager.ReadAllAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Retrieves all Provider Types", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadAllAsync" } } }, "required": true }, "responses": { "200": { "description": "A list of Provider Types" } } }, "post": { "tags": [ "Identity Module v1" ], "summary": "Updates a Provider Type, allowing you to enable or disable Provider Types\r\n in the environment. Disabling a Provider Type prevents all users from\r\n using that protocol during login.", "description": "[Public] IAuthProviderTypeManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IAuthProviderTypeManager.UpdateAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Updates a Provider Type, allowing you to enable or disable Provider Types\r\n in the environment. Disabling a Provider Type prevents all users from\r\n using that protocol during login.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/auth-provider-types/{name}": { "get": { "tags": [ "Identity Module v1" ], "summary": "Retrieves a Provider Type", "description": "[Public] IAuthProviderTypeManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IAuthProviderTypeManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/name" } ], "requestBody": { "description": "Retrieves a Provider Type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadAsync" } } }, "required": true }, "responses": { "200": { "description": "The Provider Type" } } } }, "/Relativity-Identity/v1/Group Manager/GetKeplerStatusAsync": { "get": { "tags": [ "Identity Module v1" ], "description": "Ping Endpoint", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.GetKeplerStatusAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/groups": { "post": { "tags": [ "Identity Module v1" ], "summary": "Adds a user group to Relativity.", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.CreateAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Adds a user group to Relativity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsync" } } }, "required": true }, "responses": { "200": { "description": "An object containing data about the new user group." } } } }, "/Relativity-Identity/v1/groups/{groupID}?{includeMetadata}&{includeActions}": { "get": { "tags": [ "Identity Module v1" ], "summary": "Retrieves advanced metadata for a user group, including its name, associated client, and other properties.", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/groupID" }, { "$ref": "#/components/parameters/includeMetadata" }, { "$ref": "#/components/parameters/includeActions" } ], "requestBody": { "description": "Retrieves advanced metadata for a user group, including its name, associated client, and other properties.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadAsync" } } }, "required": true }, "responses": { "200": { "description": "An object containing data about the requested user group." } } } }, "/Relativity-Identity/v1/groups/{groupID}": { "put": { "tags": [ "Identity Module v1" ], "summary": "Modifies the properties of a user group.", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.UpdateAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Modifies the properties of a user group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsync" } } }, "required": true }, "responses": { "200": { "description": "An object containing data about the updated user group." } } }, "delete": { "tags": [ "Identity Module v1" ], "summary": "Deletes a user group.", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.DeleteAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Deletes a user group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/groups/{groupID}/query-members": { "post": { "tags": [ "Identity Module v1" ], "summary": "Retrieves the list of users in a given group.", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.QueryMembersAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Retrieves the list of users in a given group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryMembersAsync" } } }, "required": true }, "responses": { "200": { "description": "Returns the results of the executed query that contains visible users in the group." } } } }, "/Relativity-Identity/v1/groups/{groupID}/members": { "post": { "tags": [ "Identity Module v1" ], "summary": "Adds a list of users to a given group.", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.AddMembersAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Adds a list of users to a given group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddMembersAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } }, "delete": { "tags": [ "Identity Module v1" ], "summary": "Removes a list of users from a given group.", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.RemoveMembersAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Removes a list of users from a given group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveMembersAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/groups/members": { "post": { "tags": [ "Identity Module v1" ], "summary": "", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.MassAddUsersToGroupsAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MassAddUsersToGroupsAsync" } } }, "required": true }, "responses": { "200": { "description": "Returns the results of a mass operation as a list of ." } } }, "delete": { "tags": [ "Identity Module v1" ], "summary": "", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.MassRemoveUsersFromGroupsAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MassRemoveUsersFromGroupsAsync" } } }, "required": true }, "responses": { "200": { "description": "Returns the results of a mass operation as a list of ." } } } }, "/Relativity-Identity/v1/groups/eligible-clients/query": { "post": { "tags": [ "Identity Module v1" ], "summary": "Query for Clients that are valid for the client property on group", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.QueryEligibleClients", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Query for Clients that are valid for the client property on group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryEligibleClients" } } }, "required": true }, "responses": { "200": { "description": "Returns the results of the executed query, or a subset of a previously run (cached) query referenced by a specified query token." } } } }, "/Relativity-Identity/v1/groups/{groupID}/eligible-members/query": { "post": { "tags": [ "Identity Module v1" ], "summary": "Query for Users that are eligible to be members of a group.", "description": "[Public] IGroupManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager.QueryEligibleUsersToAdd", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Query for Users that are eligible to be members of a group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryEligibleUsersToAdd" } } }, "required": true }, "responses": { "200": { "description": "Returns the results of the executed query, or a subset of a previously run (cached) query referenced by a specified query token." } } } }, "/Relativity-Identity/v1/Login Profile Manager/GetKeplerStatusAsync": { "get": { "tags": [ "Identity Module v1" ], "description": "Ping Endpoint", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.GetKeplerStatusAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/users/{userID}/login-profile": { "get": { "tags": [ "Identity Module v1" ], "summary": "Get a Login Method Profile for a given user.", "description": "[Public] ILoginProfileManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.GetLoginProfileAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/userID" } ], "requestBody": { "description": "Get a Login Method Profile for a given user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLoginProfileAsync" } } }, "required": true }, "responses": { "200": { "description": "The requested profile" } } }, "post": { "tags": [ "Identity Module v1" ], "summary": "Save a Login Method profile.", "description": "[Public] ILoginProfileManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.UpdateLoginProfileAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/userID" } ], "requestBody": { "description": "Save a Login Method profile.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLoginProfileAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/users/{userID}/login-profile/set/password": { "put": { "tags": [ "Identity Module v1" ], "summary": "Explicitly set a user's password. Note that admins are not allowed to reset \r\n Relativity users' passwords by default. (see Remarks for more information)", "description": "[Public] ILoginProfileManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.SetPasswordAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/userID" } ], "requestBody": { "description": "Explicitly set a user's password. Note that admins are not allowed to reset \r\n Relativity users' passwords by default. (see Remarks for more information)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetPasswordAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/users/{userID}/Invitation": { "post": { "tags": [ "Identity Module v1" ], "summary": "Sends an Invitation Workflow e-mail to the specified user.", "description": "[Public] ILoginProfileManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.SendInvitationAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/userID" } ], "requestBody": { "description": "Sends an Invitation Workflow e-mail to the specified user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendInvitationAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/Users/bulk-invitation": { "post": { "tags": [ "Identity Module v1" ], "summary": "Sends an Invitation Workflow e-mail to each specified user.", "description": "[Public] ILoginProfileManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.SendBulkInvitationAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Sends an Invitation Workflow e-mail to each specified user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendBulkInvitationAsync" } } }, "required": true }, "responses": { "200": { "description": "list of Invitation errors" } } } }, "/Relativity-Identity/v1/users/bulk-invitation/verify": { "post": { "tags": [ "Identity Module v1" ], "summary": "Verifies an Invitation Workflow without sending an email.", "description": "[Public] ILoginProfileManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.VerifyBulkInvitationAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Verifies an Invitation Workflow without sending an email.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyBulkInvitationAsync" } } }, "required": true }, "responses": { "200": { "description": "list of Invitation errors" } } } }, "/Relativity-Identity/v1/auth-profile/global": { "get": { "tags": [ "Identity Module v1" ], "summary": "Read the Global Auth Profile from the system", "description": "[Public] ILoginProfileManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.GetGlobalProfileAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Read the Global Auth Profile from the system", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalProfileAsync" } } }, "required": true }, "responses": { "200": { "description": "An Auth Profile" } } } }, "/Relativity-Identity/v1/auth-profile": { "put": { "tags": [ "Identity Module v1" ], "summary": "Save an Auth Profile", "description": "[Public] ILoginProfileManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager.SaveProfileAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Save an Auth Profile", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveProfileAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/Permission Manager/GetKeplerStatusAsync": { "get": { "tags": [ "Identity Module v1" ], "description": "Ping Endpoint", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetKeplerStatusAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/permissions": { "get": { "tags": [ "Identity Module v1" ], "summary": "Get Workspace Group Permissions.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetWorkspaceGroupPermissionsAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Get Workspace Group Permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkspaceGroupPermissionsAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } }, "put": { "tags": [ "Identity Module v1" ], "summary": "Set Workspace Group Permissions.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.SetWorkspaceGroupPermissionsAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Set Workspace Group Permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetWorkspaceGroupPermissionsAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/artifacts/{artifactID}/permissions": { "get": { "tags": [ "Identity Module v1" ], "summary": "Get Item Group Permissions.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetItemGroupPermissionsAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/artifactID" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Get Item Group Permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetItemGroupPermissionsAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } }, "put": { "tags": [ "Identity Module v1" ], "summary": "Set Item Group Permissions.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.SetItemGroupPermissionsAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/groupID" }, { "$ref": "#/components/parameters/artifactID" } ], "requestBody": { "description": "Set Item Group Permissions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetItemGroupPermissionsAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/{artifactID}/security": { "get": { "tags": [ "Identity Module v1" ], "summary": "Get Item Level Security settings for a given ArtifactID.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetItemLevelSecurityAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/artifactID" } ], "requestBody": { "description": "Get Item Level Security settings for a given ArtifactID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetItemLevelSecurityAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } }, "put": { "tags": [ "Identity Module v1" ], "summary": "Set Item Level Security settings for a given ArtifactID.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.SetItemLevelSecurityAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/artifactID" } ], "requestBody": { "description": "Set Item Level Security settings for a given ArtifactID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetItemLevelSecurityAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/list-security": { "post": { "tags": [ "Identity Module v1" ], "summary": "Returns a dictionary of item-level security settings objects for the specified Relativity artifacts. \r\n Inputs include the workspace ArtifactID and a collection of ArtifactIDs. \r\n For admin artifacts, specify -1 as the workspace ArtifactID.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetItemLevelSecurityListAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" } ], "requestBody": { "description": "Returns a dictionary of item-level security settings objects for the specified Relativity artifacts. \r\n Inputs include the workspace ArtifactID and a collection of ArtifactIDs. \r\n For admin artifacts, specify -1 as the workspace ArtifactID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetItemLevelSecurityListAsync" } } }, "required": true }, "responses": { "200": { "description": "A collection of ItemLevelSecurity with current value for each specified artifact." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/members": { "get": { "tags": [ "Identity Module v1" ], "summary": "Get Workspace Group Users.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetWorkspaceGroupUsersAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Get Workspace Group Users.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetWorkspaceGroupUsersAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/members/{userID}/is-member": { "get": { "tags": [ "Identity Module v1" ], "summary": "Determines if the given user is a member of the given workspace group", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.IsUserInWorkspaceGroupAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Determines if the given user is a member of the given workspace group", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IsUserInWorkspaceGroupAsync" } } }, "required": true }, "responses": { "200": { "description": "Returns true if user belongs to the workspace group, otherwise returns false" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/artifacts/{artifactID}/members": { "get": { "tags": [ "Identity Module v1" ], "summary": "Get Item Group Users.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetItemGroupUsersAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/artifactID" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Get Item Group Users.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetItemGroupUsersAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/permissions": { "post": { "tags": [ "Identity Module v1" ], "summary": "Asynchronously create a new permission.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.CreateSingleAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" } ], "requestBody": { "description": "Asynchronously create a new permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSingleAsync" } } }, "required": true }, "responses": { "200": { "description": "ID of the new Permission." } } }, "put": { "tags": [ "Identity Module v1" ], "summary": "Asynchronously updates a Permission.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.UpdateSingleAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" } ], "requestBody": { "description": "Asynchronously updates a Permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSingleAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/query-permissions?{length}": { "post": { "tags": [ "Identity Module v1" ], "summary": "Asynchronously queries for a subset of a collection of Permission instances.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.QueryAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/length" } ], "requestBody": { "description": "Asynchronously queries for a subset of a collection of Permission instances.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryAsync" } } }, "required": true }, "responses": { "200": { "description": "A PermissionQueryResultSet." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/query-permissions?{length}&{queryToken}&{start}": { "get": { "tags": [ "Identity Module v1" ], "summary": "Asynchronously queries for a subset of a collection of Permission instances.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.QueryAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/queryToken" }, { "$ref": "#/components/parameters/start" }, { "$ref": "#/components/parameters/length" } ], "requestBody": { "description": "Asynchronously queries for a subset of a collection of Permission instances.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryAsync" } } }, "required": true }, "responses": { "200": { "description": "A PermissionQueryResultSet." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/permissions/{permissionID}": { "get": { "tags": [ "Identity Module v1" ], "summary": "Asynchronously read a single Permission instance.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.ReadSingleAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/permissionID" } ], "requestBody": { "description": "Asynchronously read a single Permission instance.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadSingleAsync" } } }, "required": true }, "responses": { "200": { "description": "A Permission" } } }, "delete": { "tags": [ "Identity Module v1" ], "summary": "Asynchronously delets a Permission.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.DeleteSingleAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/permissionID" } ], "requestBody": { "description": "Asynchronously delets a Permission.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteSingleAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/has-access": { "get": { "tags": [ "Identity Module v1" ], "summary": "Determines if the current user has access to workspace.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.HasAccessToWorkspaceAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" } ], "requestBody": { "description": "Determines if the current user has access to workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HasAccessToWorkspaceAsync" } } }, "required": true }, "responses": { "200": { "description": "Returns true if user has access to workspace, otherwise returns false" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/list-permissions": { "post": { "tags": [ "Identity Module v1" ], "summary": "Indicates a given permission is selected. (ArtifactTypeID)", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetPermissionSelectedAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" } ], "requestBody": { "description": "Indicates a given permission is selected. (ArtifactTypeID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPermissionSelectedAsync" } } }, "required": true }, "responses": { "200": { "description": "A collection of permissions and the current value." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/{artifactID}/list-permissions": { "post": { "tags": [ "Identity Module v1" ], "summary": "Indicates a given permission is selected. (ItemLevelSecurity on an ArtifactID of a given permission ArtifactTypeID)", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetPermissionSelectedAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/artifactID" } ], "requestBody": { "description": "Indicates a given permission is selected. (ItemLevelSecurity on an ArtifactID of a given permission ArtifactTypeID)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPermissionSelectedAsync" } } }, "required": true }, "responses": { "200": { "description": "A collection of permissions and the current value." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/artifacts/list-permissions": { "post": { "tags": [ "Identity Module v1" ], "summary": "Returns the current user’s permission to the specified relativity artifacts as a dictionary that maps the ArtifactID to the permissions values. \r\n Inputs include the workspace ArtifactID, a collection of PermissionRef objects, and a collection of ArtifactIDs. \r\n To return admin-level artifact permissions, specify -1 as the workspace ArtifactID.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetPermissionSelectedListAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" } ], "requestBody": { "description": "Returns the current user’s permission to the specified relativity artifacts as a dictionary that maps the ArtifactID to the permissions values. \r\n Inputs include the workspace ArtifactID, a collection of PermissionRef objects, and a collection of ArtifactIDs. \r\n To return admin-level artifact permissions, specify -1 as the workspace ArtifactID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPermissionSelectedListAsync" } } }, "required": true }, "responses": { "200": { "description": "A collection of permissions with current value for each specified artifact." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/list-permissions": { "post": { "tags": [ "Identity Module v1" ], "summary": "Indicates a given permission is selected. (ArtifactTypeID for a given Group)", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetPermissionSelectedForGroupAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/groupID" } ], "requestBody": { "description": "Indicates a given permission is selected. (ArtifactTypeID for a given Group)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPermissionSelectedForGroupAsync" } } }, "required": true }, "responses": { "200": { "description": "A collection of permissions and the current value." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/Admin/list-permissions": { "post": { "tags": [ "Identity Module v1" ], "summary": "Indicates if a given admin permission is selected.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetAdminOperationPermissionSelectedListAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" } ], "requestBody": { "description": "Indicates if a given admin permission is selected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAdminOperationPermissionSelectedListAsync" } } }, "required": true }, "responses": { "200": { "description": "A collection of permissions and if it is selected." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupID}/artifacts/{artifactID}/list-permissions": { "post": { "tags": [ "Identity Module v1" ], "summary": "Indicates a given permission is selected. (ItemLevelSecurity on an ArtifactID of a given permission ArtifactTypeID for a given Group)", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetPermissionSelectedForGroupAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/groupID" }, { "$ref": "#/components/parameters/artifactID" } ], "requestBody": { "description": "Indicates a given permission is selected. (ItemLevelSecurity on an ArtifactID of a given permission ArtifactTypeID for a given Group)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPermissionSelectedForGroupAsync" } } }, "required": true }, "responses": { "200": { "description": "A collection of permissions and the current value." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceArtifactID}/groups/{groupArtifactID}/tab-visibility": { "get": { "tags": [ "Identity Module v1" ], "summary": "Get a list of tabs for the group and the tab visibility state.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.GetGroupTabVisibilityAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/groupArtifactID" } ], "requestBody": { "description": "Get a list of tabs for the group and the tab visibility state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGroupTabVisibilityAsync" } } }, "required": true }, "responses": { "200": { "description": "The tab visibility state for the group." } } }, "put": { "tags": [ "Identity Module v1" ], "summary": "Update the tab visibility state for a group.", "description": "[Public] IPermissionManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager.SetGroupTabVisibilityAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceArtifactID" }, { "$ref": "#/components/parameters/groupArtifactID" } ], "requestBody": { "description": "Update the tab visibility state for a group.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetGroupTabVisibilityAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/User Manager/GetKeplerStatusAsync": { "get": { "tags": [ "Identity Module v1" ], "description": "Ping Endpoint", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.GetKeplerStatusAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/users/{userID}/query-groups": { "post": { "tags": [ "Identity Module v1" ], "summary": "", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.QueryGroupsByUserAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/userID" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryGroupsByUserAsync" } } }, "required": true }, "responses": { "200": { "description": "Returns the results of the executed query that contains visible groups where the user is a member." } } } }, "/Relativity-Identity/v1/users/query-eligible-groups": { "post": { "tags": [ "Identity Module v1" ], "summary": "Query for Groups that are eligible for adding at least one of specified users.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.QueryEligibleGroupsToAddUsersToAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Query for Groups that are eligible for adding at least one of specified users.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryEligibleGroupsToAddUsersToAsync" } } }, "required": true }, "responses": { "200": { "description": "Returns the results of the executed query, or a subset of a previously run (cached) query referenced by a specified query token." } } } }, "/Relativity-Identity/v1/users": { "post": { "tags": [ "Identity Module v1" ], "summary": "Adds a single user to Relativity.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.CreateAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Adds a single user to Relativity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAsync" } } }, "required": true }, "responses": { "200": { "description": "An object containing data about the new user." } } } }, "/Relativity-Identity/v1/users/{userID}?{includeMetadata}&{includeActions}": { "get": { "tags": [ "Identity Module v1" ], "summary": "Retrieves advanced metadata for a user, including their Relativity access, name, email, and other properties.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.ReadAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/userID" }, { "$ref": "#/components/parameters/includeMetadata" }, { "$ref": "#/components/parameters/includeActions" } ], "requestBody": { "description": "Retrieves advanced metadata for a user, including their Relativity access, name, email, and other properties.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadAsync" } } }, "required": true }, "responses": { "200": { "description": "An object containing data about the requested user." } } } }, "/Relativity-Identity/v1/users/me/settings?{includeMetadata}?{includeActions}": { "get": { "tags": [ "Identity Module v1" ], "summary": "Retrieves settings for the current user, including their name, email, and other properties.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.ReadSettingsAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/includeMetadata" }, { "$ref": "#/components/parameters/includeActions" } ], "requestBody": { "description": "Retrieves settings for the current user, including their name, email, and other properties.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadSettingsAsync" } } }, "required": true }, "responses": { "200": { "description": "An object containing data about the current user." } } } }, "/Relativity-Identity/v1/users/{userID}": { "put": { "tags": [ "Identity Module v1" ], "summary": "Modifies the properties of a user.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.UpdateAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/userID" } ], "requestBody": { "description": "Modifies the properties of a user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAsync" } } }, "required": true }, "responses": { "200": { "description": "An object containing data about the updated user." } } }, "delete": { "tags": [ "Identity Module v1" ], "summary": "Deletes a user.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.DeleteAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/userID" } ], "requestBody": { "description": "Deletes a user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteAsync" } } }, "required": true }, "responses": { "200": { "description": "Successful operation" } } } }, "/Relativity-Identity/v1/users/me/settings": { "put": { "tags": [ "Identity Module v1" ], "summary": "Modifies the user setting properties of the current user.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.UpdateSettingsAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Modifies the user setting properties of the current user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSettingsAsync" } } }, "required": true }, "responses": { "200": { "description": "An object containing data about the updated user." } } } }, "/Relativity-Identity/v1/users/available-types": { "get": { "tags": [ "Identity Module v1" ], "summary": "Gets all possible types for the User", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.GetAvailableTypesAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" } ], "requestBody": { "description": "Gets all possible types for the User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAvailableTypesAsync" } } }, "required": true }, "responses": { "200": { "description": "A list of possible choices for a user's type." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceID}/users": { "get": { "tags": [ "Identity Module v1" ], "summary": "Gets a list of all users and their information for a given workspace.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.RetrieveAll", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceID" } ], "requestBody": { "description": "Gets a list of all users and their information for a given workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAll" } } }, "required": true }, "responses": { "200": { "description": "All users and their information for a given workspace." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceID}/query-users": { "post": { "tags": [ "Identity Module v1" ], "summary": "Gets a list of users and their information, and supports filtering, ordering, and paging these results.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.RetrieveUsersBy", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceID" } ], "requestBody": { "description": "Gets a list of users and their information, and supports filtering, ordering, and paging these results.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveUsersBy" } } }, "required": true }, "responses": { "200": { "description": "Returns the user and related information as results of the executed query." } } } }, "/Relativity-Identity/v1/workspaces/{workspaceID}/users/me": { "get": { "tags": [ "Identity Module v1" ], "summary": "Asynchronously retrieves the current user in the specified workspace. NOTE: User Artifact ID may differ for the same user in different workspaces.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.RetrieveCurrentAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceID" } ], "requestBody": { "description": "Asynchronously retrieves the current user in the specified workspace. NOTE: User Artifact ID may differ for the same user in different workspaces.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveCurrentAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceID}/all-users?{includeDeleted}": { "get": { "tags": [ "Identity Module v1" ], "summary": "Asynchronously retrieves a list of all users in a workspace, including administrators and (optional) deleted users.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.ReadAllUsersAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceID" }, { "$ref": "#/components/parameters/includeDeleted" } ], "requestBody": { "description": "Asynchronously retrieves a list of all users in a workspace, including administrators and (optional) deleted users.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadAllUsersAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceID}/active-users?{includeCurrentUser}&{enforceChoiceLimitForUI}": { "get": { "tags": [ "Identity Module v1" ], "summary": "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.", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.ReadActiveUsersAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceID" }, { "$ref": "#/components/parameters/includeCurrentUser" }, { "$ref": "#/components/parameters/enforceChoiceLimitForUI" } ], "requestBody": { "description": "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.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadActiveUsersAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } } }, "/Relativity-Identity/v1/workspaces/{workspaceID}/users-with-access": { "get": { "tags": [ "Identity Module v1" ], "summary": "", "description": "[Public] IUserManager", "operationId": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager.RetrieveAllWithRelativityAccessAsync", "parameters": [ { "$ref": "#/components/parameters/X-CSRF-Header" }, { "$ref": "#/components/parameters/workspaceID" } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveAllWithRelativityAccessAsync" } } }, "required": true }, "responses": { "200": { "description": "No description set" } } } } }, "components": { "schemas": { "ReadAllAsync": { "title": "ReadAllAsync", "description": "Read all Federated Instances" }, "CreateAsync": { "title": "CreateAsync", "required": [ "instance" ], "properties": { "instance": { "title": "FederatedInstance", "required": [ "Name", "InstanceUrl" ], "type": "object", "properties": { "Name": { "type": "string", "description": "", "format": "System.String" }, "InstanceUrl": { "type": "uri", "description": "", "format": "System.Uri" } }, "additionalProperties": false, "description": "The Federated Instance to create" } }, "description": "Create a new Federated Instance" }, "UpdateAsync": { "title": "UpdateAsync", "required": [ "instance" ], "properties": { "instance": { "title": "FederatedInstance", "required": [ "Name", "InstanceUrl" ], "type": "object", "properties": { "Name": { "type": "string", "description": "", "format": "System.String" }, "InstanceUrl": { "type": "uri", "description": "", "format": "System.Uri" } }, "additionalProperties": false, "description": "The instance to update" } }, "description": "Update an existing Federated Instance" }, "ReadAsync": { "title": "ReadAsync", "description": "Read a Federated Instance" }, "DeleteAsync": { "title": "DeleteAsync", "description": "Remove a Federated Instance from this Relativity instance" }, "SaveAsync": { "title": "SaveAsync", "required": [ "client" ], "properties": { "client": { "title": "OAuth2Client", "required": [ "AccessTokenLifetimeInMinutes", "Name", "Description", "Enabled", "Flow", "ID", "IsSystem", "RedirectUris", "Secret", "Scopes", "ContextUser", "Claims" ], "type": "object", "properties": { "AccessTokenLifetimeInMinutes": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" }, "Description": { "type": "string", "description": "", "format": "System.String" }, "Enabled": { "type": "boolean", "description": "", "format": "System.Boolean" }, "Flow": { "type": "object" }, "ID": { "type": "string", "description": "", "format": "System.String" }, "IsSystem": { "type": "boolean", "description": "", "format": "System.Boolean" }, "RedirectUris": { "type": "array", "items": { "type": "uri", "format": "System.Uri" }, "description": "" }, "Secret": { "type": "string", "description": "", "format": "System.String" }, "Scopes": { "type": "array", "items": { "type": "string", "format": "System.String" }, "description": "" }, "ContextUser": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "Claims": { "type": "array", "items": {}, "description": "" } }, "additionalProperties": false, "description": "The OAuth2 Client to save." } }, "description": "Save an OAuth2 Client." }, "RegenerateSecretAsync": { "title": "RegenerateSecretAsync", "description": "Generate a new secret for an OAuth2 Client. All previous secrets are immediately invalidated." }, "QueryMembersAsync": { "title": "QueryMembersAsync", "required": [ "request", "start", "length" ], "properties": { "request": { "title": "QueryRequest", "required": [ "ObjectType", "Condition", "Sorts", "RelationalField", "RowCondition", "SearchProviderCondition", "SampleParameters", "IncludeIDWindow", "RankSortOrder", "QueryHint", "Fields", "IsAdhocQuery", "ConvertNumberFieldValuesToString", "IncludeNameInQueryResult", "ExecutingSavedSearchID", "ExecutingViewID", "ActiveArtifactID", "MaxCharactersForLongTextValues", "LongTextBehavior" ], "type": "object", "properties": { "ObjectType": { "required": [ "ArtifactID", "Name", "Guid", "ArtifactTypeID" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ArtifactTypeID": { "type": "integer", "description": "", "format": "System.Int32" } } }, "Condition": { "type": "string", "description": "", "format": "System.String" }, "Sorts": { "type": "array", "items": {}, "description": "" }, "RelationalField": { "required": [ "ViewFieldID", "ArtifactID", "Guid", "Name" ], "type": "object", "properties": { "ViewFieldID": { "type": "integer", "description": "", "format": "System.Int32" }, "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "RowCondition": { "type": "string", "description": "", "format": "System.String" }, "SearchProviderCondition": { "required": [ "SearchIndex", "Input" ], "type": "object", "properties": { "SearchIndex": { "required": [ "ArtifactID", "Name" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "Input": { "type": "string", "description": "", "format": "System.String" } } }, "SampleParameters": { "required": [ "ExistingToken", "MarginOfError", "ConfidenceLevel", "FixedSampleSize", "SamplingPercentage" ], "type": "object", "properties": { "ExistingToken": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MarginOfError": { "type": "number", "description": "", "format": "System.Decimal" }, "ConfidenceLevel": { "type": "number", "description": "", "format": "System.Decimal" }, "FixedSampleSize": { "type": "integer", "description": "", "format": "System.Int32" }, "SamplingPercentage": { "type": "number", "description": "", "format": "System.Decimal" } } }, "IncludeIDWindow": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "RankSortOrder": { "type": "nullable`1[[relativity.identity.server.v1.shared.sortenum, relativity.identity.server, version=11.3.0.0, culture=neutral, publickeytoken=null]]", "description": "", "format": "System.Nullable`1[[Relativity.Identity.Server.V1.Shared.SortEnum, Relativity.Identity.Server, Version=11.3.0.0, Culture=neutral, PublicKeyToken=null]]" }, "QueryHint": { "type": "string", "description": "", "format": "System.String" }, "Fields": { "type": "array", "items": {}, "description": "" }, "IsAdhocQuery": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ConvertNumberFieldValuesToString": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "IncludeNameInQueryResult": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingSavedSearchID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingViewID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ActiveArtifactID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MaxCharactersForLongTextValues": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "LongTextBehavior": { "type": "object" } }, "additionalProperties": false, "description": "A QueryRequest object containing conditions, sorting order, fields and other information for the query." }, "start": { "type": "integer", "description": "Index of the first artifact in the returned QueryResultSet object.", "format": "integer" }, "length": { "type": "integer", "description": "Number of items to return in the query result, starting with index in the start parameter.", "format": "integer" } }, "description": "Retrieves the list of users in a given group." }, "AddMembersAsync": { "title": "AddMembersAsync", "required": [ "users" ], "properties": { "users": { "type": "array", "items": {}, "description": "The list of identifiers for users to add to the group." } }, "description": "Adds a list of users to a given group." }, "RemoveMembersAsync": { "title": "RemoveMembersAsync", "required": [ "users" ], "properties": { "users": { "type": "array", "items": {}, "description": "The list of identifiers for users to remove from the group." } }, "description": "Removes a list of users from a given group." }, "MassAddUsersToGroupsAsync": { "title": "MassAddUsersToGroupsAsync", "required": [ "users", "groups" ], "properties": { "users": { "type": "array", "items": {}, "description": "The list of identifiers for users to add to the list of user groups." }, "groups": { "type": "array", "items": {}, "description": "The list of identifiers for groups where users are being added." } }, "description": "" }, "MassRemoveUsersFromGroupsAsync": { "title": "MassRemoveUsersFromGroupsAsync", "required": [ "users", "groups" ], "properties": { "users": { "type": "array", "items": {}, "description": "The list of identifiers for users to remove from the list of user group." }, "groups": { "type": "array", "items": {}, "description": "The list of identifiers for groups where users are being removed." } }, "description": "" }, "QueryEligibleClients": { "title": "QueryEligibleClients", "required": [ "request", "start", "length" ], "properties": { "request": { "title": "QueryRequest", "required": [ "ObjectType", "Condition", "Sorts", "RelationalField", "RowCondition", "SearchProviderCondition", "SampleParameters", "IncludeIDWindow", "RankSortOrder", "QueryHint", "Fields", "IsAdhocQuery", "ConvertNumberFieldValuesToString", "IncludeNameInQueryResult", "ExecutingSavedSearchID", "ExecutingViewID", "ActiveArtifactID", "MaxCharactersForLongTextValues", "LongTextBehavior" ], "type": "object", "properties": { "ObjectType": { "required": [ "ArtifactID", "Name", "Guid", "ArtifactTypeID" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ArtifactTypeID": { "type": "integer", "description": "", "format": "System.Int32" } } }, "Condition": { "type": "string", "description": "", "format": "System.String" }, "Sorts": { "type": "array", "items": {}, "description": "" }, "RelationalField": { "required": [ "ViewFieldID", "ArtifactID", "Guid", "Name" ], "type": "object", "properties": { "ViewFieldID": { "type": "integer", "description": "", "format": "System.Int32" }, "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "RowCondition": { "type": "string", "description": "", "format": "System.String" }, "SearchProviderCondition": { "required": [ "SearchIndex", "Input" ], "type": "object", "properties": { "SearchIndex": { "required": [ "ArtifactID", "Name" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "Input": { "type": "string", "description": "", "format": "System.String" } } }, "SampleParameters": { "required": [ "ExistingToken", "MarginOfError", "ConfidenceLevel", "FixedSampleSize", "SamplingPercentage" ], "type": "object", "properties": { "ExistingToken": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MarginOfError": { "type": "number", "description": "", "format": "System.Decimal" }, "ConfidenceLevel": { "type": "number", "description": "", "format": "System.Decimal" }, "FixedSampleSize": { "type": "integer", "description": "", "format": "System.Int32" }, "SamplingPercentage": { "type": "number", "description": "", "format": "System.Decimal" } } }, "IncludeIDWindow": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "RankSortOrder": { "type": "nullable`1[[relativity.identity.server.v1.shared.sortenum, relativity.identity.server, version=11.3.0.0, culture=neutral, publickeytoken=null]]", "description": "", "format": "System.Nullable`1[[Relativity.Identity.Server.V1.Shared.SortEnum, Relativity.Identity.Server, Version=11.3.0.0, Culture=neutral, PublicKeyToken=null]]" }, "QueryHint": { "type": "string", "description": "", "format": "System.String" }, "Fields": { "type": "array", "items": {}, "description": "" }, "IsAdhocQuery": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ConvertNumberFieldValuesToString": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "IncludeNameInQueryResult": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingSavedSearchID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingViewID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ActiveArtifactID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MaxCharactersForLongTextValues": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "LongTextBehavior": { "type": "object" } }, "additionalProperties": false, "description": "A QueryRequest object containing conditions, sorting order, fields and other information for the query." }, "start": { "type": "integer", "description": "Index of the first artifact in the returned QueryResultSet object.", "format": "integer" }, "length": { "type": "integer", "description": "Number of items to return in the query result, starting with index in the start parameter.", "format": "integer" } }, "description": "Query for Clients that are valid for the client property on group" }, "QueryEligibleUsersToAdd": { "title": "QueryEligibleUsersToAdd", "required": [ "request", "start", "length" ], "properties": { "request": { "title": "QueryRequest", "required": [ "ObjectType", "Condition", "Sorts", "RelationalField", "RowCondition", "SearchProviderCondition", "SampleParameters", "IncludeIDWindow", "RankSortOrder", "QueryHint", "Fields", "IsAdhocQuery", "ConvertNumberFieldValuesToString", "IncludeNameInQueryResult", "ExecutingSavedSearchID", "ExecutingViewID", "ActiveArtifactID", "MaxCharactersForLongTextValues", "LongTextBehavior" ], "type": "object", "properties": { "ObjectType": { "required": [ "ArtifactID", "Name", "Guid", "ArtifactTypeID" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ArtifactTypeID": { "type": "integer", "description": "", "format": "System.Int32" } } }, "Condition": { "type": "string", "description": "", "format": "System.String" }, "Sorts": { "type": "array", "items": {}, "description": "" }, "RelationalField": { "required": [ "ViewFieldID", "ArtifactID", "Guid", "Name" ], "type": "object", "properties": { "ViewFieldID": { "type": "integer", "description": "", "format": "System.Int32" }, "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "RowCondition": { "type": "string", "description": "", "format": "System.String" }, "SearchProviderCondition": { "required": [ "SearchIndex", "Input" ], "type": "object", "properties": { "SearchIndex": { "required": [ "ArtifactID", "Name" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "Input": { "type": "string", "description": "", "format": "System.String" } } }, "SampleParameters": { "required": [ "ExistingToken", "MarginOfError", "ConfidenceLevel", "FixedSampleSize", "SamplingPercentage" ], "type": "object", "properties": { "ExistingToken": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MarginOfError": { "type": "number", "description": "", "format": "System.Decimal" }, "ConfidenceLevel": { "type": "number", "description": "", "format": "System.Decimal" }, "FixedSampleSize": { "type": "integer", "description": "", "format": "System.Int32" }, "SamplingPercentage": { "type": "number", "description": "", "format": "System.Decimal" } } }, "IncludeIDWindow": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "RankSortOrder": { "type": "nullable`1[[relativity.identity.server.v1.shared.sortenum, relativity.identity.server, version=11.3.0.0, culture=neutral, publickeytoken=null]]", "description": "", "format": "System.Nullable`1[[Relativity.Identity.Server.V1.Shared.SortEnum, Relativity.Identity.Server, Version=11.3.0.0, Culture=neutral, PublicKeyToken=null]]" }, "QueryHint": { "type": "string", "description": "", "format": "System.String" }, "Fields": { "type": "array", "items": {}, "description": "" }, "IsAdhocQuery": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ConvertNumberFieldValuesToString": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "IncludeNameInQueryResult": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingSavedSearchID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingViewID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ActiveArtifactID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MaxCharactersForLongTextValues": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "LongTextBehavior": { "type": "object" } }, "additionalProperties": false, "description": "A QueryRequest object containing conditions, sorting order, fields and other information for the query." }, "start": { "type": "integer", "description": "Index of the first artifact in the returned QueryResultSet object.", "format": "integer" }, "length": { "type": "integer", "description": "Number of items to return in the query result, starting with index in the start parameter.", "format": "integer" } }, "description": "Query for Users that are eligible to be members of a group." }, "GetLoginProfileAsync": { "title": "GetLoginProfileAsync", "description": "Get a Login Method Profile for a given user." }, "UpdateLoginProfileAsync": { "title": "UpdateLoginProfileAsync", "required": [ "profile" ], "properties": { "profile": { "title": "LoginProfile", "required": [ "UserID", "Password", "IntegratedAuthentication", "ActiveDirectory", "ClientCertificate", "RSA", "OpenIDConnectMethods", "SAML2Methods" ], "type": "object", "properties": { "UserID": { "type": "integer", "description": "", "format": "System.Int32" }, "Password": { "required": [ "Email", "InvalidLoginAttempts", "IsEnabled", "MustResetPasswordOnNextLogin", "UserCanChangePassword", "PasswordExpirationInDays", "PasswordExpires", "TwoFactorInfo", "TwoFactorMode" ], "type": "object", "properties": { "Email": { "type": "string", "description": "", "format": "System.String" }, "InvalidLoginAttempts": { "type": "integer", "description": "", "format": "System.Int32" }, "IsEnabled": { "type": "boolean", "description": "", "format": "System.Boolean" }, "MustResetPasswordOnNextLogin": { "type": "boolean", "description": "", "format": "System.Boolean" }, "UserCanChangePassword": { "type": "boolean", "description": "", "format": "System.Boolean" }, "PasswordExpirationInDays": { "type": "integer", "description": "", "format": "System.Int32" }, "PasswordExpires": { "type": "datetime", "description": "", "format": "System.DateTime" }, "TwoFactorInfo": { "type": "string", "description": "", "format": "System.String" }, "TwoFactorMode": { "type": "object" } } }, "IntegratedAuthentication": { "required": [ "Account", "IsEnabled" ], "type": "object", "properties": { "Account": { "type": "string", "description": "", "format": "System.String" }, "IsEnabled": { "type": "boolean", "description": "", "format": "System.Boolean" } } }, "ActiveDirectory": { "required": [ "Account", "IsEnabled" ], "type": "object", "properties": { "Account": { "type": "string", "description": "", "format": "System.String" }, "IsEnabled": { "type": "boolean", "description": "", "format": "System.Boolean" } } }, "ClientCertificate": { "required": [ "Name", "Subject", "IsEnabled" ], "type": "object", "properties": { "Name": { "type": "string", "description": "", "format": "System.String" }, "Subject": { "type": "string", "description": "", "format": "System.String" }, "IsEnabled": { "type": "boolean", "description": "", "format": "System.Boolean" } } }, "RSA": { "required": [ "Subject", "IsEnabled" ], "type": "object", "properties": { "Subject": { "type": "string", "description": "", "format": "System.String" }, "IsEnabled": { "type": "boolean", "description": "", "format": "System.Boolean" } } }, "OpenIDConnectMethods": { "type": "array", "items": {}, "description": "" }, "SAML2Methods": { "type": "array", "items": {}, "description": "" } }, "additionalProperties": false, "description": "The profile to save" } }, "description": "Save a Login Method profile." }, "SetPasswordAsync": { "title": "SetPasswordAsync", "required": [ "password" ], "properties": { "password": { "type": "string", "description": "The new password for the user. Passwords must meet \r\n the password complexity criteria configured for this environment.", "format": "string" } }, "description": "Explicitly set a user's password. Note that admins are not allowed to reset \r\n Relativity users' passwords by default. (see Remarks for more information)" }, "SendInvitationAsync": { "title": "SendInvitationAsync", "description": "Sends an Invitation Workflow e-mail to the specified user." }, "SendBulkInvitationAsync": { "title": "SendBulkInvitationAsync", "required": [ "userIDList" ], "properties": { "userIDList": { "type": "array", "items": { "type": "integer", "format": "System.Int32" }, "description": "The list of users" } }, "description": "Sends an Invitation Workflow e-mail to each specified user." }, "VerifyBulkInvitationAsync": { "title": "VerifyBulkInvitationAsync", "required": [ "userIDList" ], "properties": { "userIDList": { "type": "array", "items": { "type": "integer", "format": "System.Int32" }, "description": "The list of users" } }, "description": "Verifies an Invitation Workflow without sending an email." }, "GetGlobalProfileAsync": { "title": "GetGlobalProfileAsync", "description": "Read the Global Auth Profile from the system" }, "SaveProfileAsync": { "title": "SaveProfileAsync", "required": [ "profile" ], "properties": { "profile": { "title": "AuthProfile", "required": [ "ID", "SiteUri", "IsGlobal", "Description", "Password", "IntegratedAuthentication", "ActiveDirectory", "ClientCertificate", "RSA", "OpenIDConnectProviders", "SAML2Providers" ], "type": "object", "properties": { "ID": { "type": "integer", "description": "", "format": "System.Int32" }, "SiteUri": { "type": "uri", "description": "", "format": "System.Uri" }, "IsGlobal": { "type": "boolean", "description": "", "format": "System.Boolean" }, "Description": { "type": "string", "description": "", "format": "System.String" }, "Password": { "required": [ "Name", "IsEnabled", "MinimumPasswordLength", "MaximumPasswordLength", "MaximumPasswordAgeInDaysDefaultValue", "UsersCanChangePasswordDefaultValue", "AllowEmailPasswordRecovery", "PasswordRecoveryRequestLimit", "MaximumPasswordHistory", "MaximumInvalidLoginAttempts", "AdditionalWorkFactor" ], "type": "object", "properties": { "Name": { "type": "string", "description": "", "format": "System.String" }, "IsEnabled": { "type": "boolean", "description": "", "format": "System.Boolean" }, "MinimumPasswordLength": { "type": "integer", "description": "", "format": "System.Int32" }, "MaximumPasswordLength": { "type": "integer", "description": "", "format": "System.Int32" }, "MaximumPasswordAgeInDaysDefaultValue": { "type": "integer", "description": "", "format": "System.Int32" }, "UsersCanChangePasswordDefaultValue": { "type": "boolean", "description": "", "format": "System.Boolean" }, "AllowEmailPasswordRecovery": { "type": "boolean", "description": "", "format": "System.Boolean" }, "PasswordRecoveryRequestLimit": { "type": "integer", "description": "", "format": "System.Int32" }, "MaximumPasswordHistory": { "type": "integer", "description": "", "format": "System.Int32" }, "MaximumInvalidLoginAttempts": { "type": "integer", "description": "", "format": "System.Int32" }, "AdditionalWorkFactor": { "type": "integer", "description": "", "format": "System.Int32" } } }, "IntegratedAuthentication": { "required": [ "Name", "IsEnabled" ], "type": "object", "properties": { "Name": { "type": "string", "description": "", "format": "System.String" }, "IsEnabled": { "type": "boolean", "description": "", "format": "System.Boolean" } } }, "ActiveDirectory": { "required": [ "Name", "IsEnabled" ], "type": "object", "properties": { "Name": { "type": "string", "description": "", "format": "System.String" }, "IsEnabled": { "type": "boolean", "description": "", "format": "System.Boolean" } } }, "ClientCertificate": { "required": [ "Name", "Description", "IsEnabled", "DisplayOnLoginPage", "Caption" ], "type": "object", "properties": { "Name": { "type": "string", "description": "", "format": "System.String" }, "Description": { "type": "string", "description": "", "format": "System.String" }, "IsEnabled": { "type": "boolean", "description": "", "format": "System.Boolean" }, "DisplayOnLoginPage": { "type": "boolean", "description": "", "format": "System.Boolean" }, "Caption": { "type": "string", "description": "", "format": "System.String" } } }, "RSA": { "required": [ "Name", "IsEnabled" ], "type": "object", "properties": { "Name": { "type": "string", "description": "", "format": "System.String" }, "IsEnabled": { "type": "boolean", "description": "", "format": "System.Boolean" } } }, "OpenIDConnectProviders": { "type": "array", "items": {}, "description": "" }, "SAML2Providers": { "type": "array", "items": {}, "description": "" } }, "additionalProperties": false, "description": "The profile to save" } }, "description": "Save an Auth Profile" }, "GetWorkspaceGroupPermissionsAsync": { "title": "GetWorkspaceGroupPermissionsAsync", "description": "Get Workspace Group Permissions." }, "SetWorkspaceGroupPermissionsAsync": { "title": "SetWorkspaceGroupPermissionsAsync", "required": [ "groupPermissions" ], "properties": { "groupPermissions": { "title": "GroupPermissions", "required": [ "ArtifactID", "GroupID", "ObjectPermissions", "TabVisibility", "BrowserPermissions", "MassActionPermissions", "AdminPermissions", "LastModified" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "GroupID": { "type": "integer", "description": "", "format": "System.Int32" }, "ObjectPermissions": { "type": "array", "items": {}, "description": "" }, "TabVisibility": { "type": "array", "items": {}, "description": "" }, "BrowserPermissions": { "type": "array", "items": {}, "description": "" }, "MassActionPermissions": { "type": "array", "items": {}, "description": "" }, "AdminPermissions": { "type": "array", "items": {}, "description": "" }, "LastModified": { "type": "datetime", "description": "", "format": "System.DateTime" } }, "additionalProperties": false, "description": "Group Permissions." } }, "description": "Set Workspace Group Permissions." }, "GetItemGroupPermissionsAsync": { "title": "GetItemGroupPermissionsAsync", "description": "Get Item Group Permissions." }, "SetItemGroupPermissionsAsync": { "title": "SetItemGroupPermissionsAsync", "required": [ "groupPermissions" ], "properties": { "groupPermissions": { "title": "GroupPermissions", "required": [ "ArtifactID", "GroupID", "ObjectPermissions", "TabVisibility", "BrowserPermissions", "MassActionPermissions", "AdminPermissions", "LastModified" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "GroupID": { "type": "integer", "description": "", "format": "System.Int32" }, "ObjectPermissions": { "type": "array", "items": {}, "description": "" }, "TabVisibility": { "type": "array", "items": {}, "description": "" }, "BrowserPermissions": { "type": "array", "items": {}, "description": "" }, "MassActionPermissions": { "type": "array", "items": {}, "description": "" }, "AdminPermissions": { "type": "array", "items": {}, "description": "" }, "LastModified": { "type": "datetime", "description": "", "format": "System.DateTime" } }, "additionalProperties": false, "description": "Group Permissions." } }, "description": "Set Item Group Permissions." }, "GetItemLevelSecurityAsync": { "title": "GetItemLevelSecurityAsync", "description": "Get Item Level Security settings for a given ArtifactID." }, "SetItemLevelSecurityAsync": { "title": "SetItemLevelSecurityAsync", "required": [ "itemLevelSecurity" ], "properties": { "itemLevelSecurity": { "title": "ItemLevelSecurity", "required": [ "ArtifactID", "Enabled", "LastModified" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Enabled": { "type": "boolean", "description": "", "format": "System.Boolean" }, "LastModified": { "type": "datetime", "description": "", "format": "System.DateTime" } }, "additionalProperties": false, "description": "ItemLevelSecurity." } }, "description": "Set Item Level Security settings for a given ArtifactID." }, "GetItemLevelSecurityListAsync": { "title": "GetItemLevelSecurityListAsync", "required": [ "artifactIDs" ], "properties": { "artifactIDs": { "type": "array", "items": { "type": "integer", "format": "System.Int32" }, "description": "Collection of ArtifactIDs" } }, "description": "Returns a dictionary of item-level security settings objects for the specified Relativity artifacts. \r\n Inputs include the workspace ArtifactID and a collection of ArtifactIDs. \r\n For admin artifacts, specify -1 as the workspace ArtifactID." }, "GetWorkspaceGroupUsersAsync": { "title": "GetWorkspaceGroupUsersAsync", "description": "Get Workspace Group Users." }, "IsUserInWorkspaceGroupAsync": { "title": "IsUserInWorkspaceGroupAsync", "description": "Determines if the given user is a member of the given workspace group" }, "GetItemGroupUsersAsync": { "title": "GetItemGroupUsersAsync", "description": "Get Item Group Users." }, "CreateSingleAsync": { "title": "CreateSingleAsync", "required": [ "permissionDTO" ], "properties": { "permissionDTO": { "title": "Permission", "required": [ "Name", "ArtifactType", "PermissionID", "PermissionType" ], "type": "object", "properties": { "Name": { "type": "string", "description": "", "format": "System.String" }, "ArtifactType": { "required": [ "ID", "Guids" ], "type": "object", "properties": { "ID": { "type": "integer", "description": "", "format": "System.Int32" }, "Guids": { "type": "array", "items": { "type": "guid", "format": "System.Guid" }, "description": "" } } }, "PermissionID": { "type": "integer", "description": "", "format": "System.Int32" }, "PermissionType": { "required": [ "ID", "Name" ], "type": "object", "properties": { "ID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" } } } }, "additionalProperties": false, "description": "Permission DTO." } }, "description": "Asynchronously create a new permission." }, "UpdateSingleAsync": { "title": "UpdateSingleAsync", "required": [ "permissionDTO" ], "properties": { "permissionDTO": { "title": "Permission", "required": [ "Name", "ArtifactType", "PermissionID", "PermissionType" ], "type": "object", "properties": { "Name": { "type": "string", "description": "", "format": "System.String" }, "ArtifactType": { "required": [ "ID", "Guids" ], "type": "object", "properties": { "ID": { "type": "integer", "description": "", "format": "System.Int32" }, "Guids": { "type": "array", "items": { "type": "guid", "format": "System.Guid" }, "description": "" } } }, "PermissionID": { "type": "integer", "description": "", "format": "System.Int32" }, "PermissionType": { "required": [ "ID", "Name" ], "type": "object", "properties": { "ID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" } } } }, "additionalProperties": false, "description": "Permission DTO to update." } }, "description": "Asynchronously updates a Permission." }, "QueryAsync": { "title": "QueryAsync", "required": [ "query" ], "properties": { "query": { "title": "Query", "required": [ "Condition", "Sorts", "RelationalField", "RowCondition", "SearchProviderCondition", "ExecutingSavedSearchId", "SampleParameters", "IncludeIdWindow", "RankSortOrder", "QueryHint" ], "type": "object", "properties": { "Condition": { "type": "string", "description": "", "format": "System.String" }, "Sorts": { "type": "array", "items": {}, "description": "" }, "RelationalField": { "required": [ "ViewFieldID", "ArtifactID", "Guid", "Name" ], "type": "object", "properties": { "ViewFieldID": { "type": "integer", "description": "", "format": "System.Int32" }, "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "RowCondition": { "type": "string", "description": "", "format": "System.String" }, "SearchProviderCondition": { "required": [ "SearchIndex", "Input" ], "type": "object", "properties": { "SearchIndex": { "required": [ "ArtifactID", "Name" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "Input": { "type": "string", "description": "", "format": "System.String" } } }, "ExecutingSavedSearchId": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "SampleParameters": { "required": [ "ExistingToken", "MarginOfError", "ConfidenceLevel", "FixedSampleSize", "SamplingPercentage" ], "type": "object", "properties": { "ExistingToken": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MarginOfError": { "type": "number", "description": "", "format": "System.Decimal" }, "ConfidenceLevel": { "type": "number", "description": "", "format": "System.Decimal" }, "FixedSampleSize": { "type": "integer", "description": "", "format": "System.Int32" }, "SamplingPercentage": { "type": "number", "description": "", "format": "System.Decimal" } } }, "IncludeIdWindow": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "RankSortOrder": { "type": "string", "description": "", "format": "System.String" }, "QueryHint": { "type": "string", "description": "", "format": "System.String" } }, "additionalProperties": false, "description": "Search Query." } }, "description": "Asynchronously queries for a subset of a collection of Permission instances." }, "ReadSingleAsync": { "title": "ReadSingleAsync", "description": "Asynchronously read a single Permission instance." }, "DeleteSingleAsync": { "title": "DeleteSingleAsync", "description": "Asynchronously delets a Permission." }, "HasAccessToWorkspaceAsync": { "title": "HasAccessToWorkspaceAsync", "description": "Determines if the current user has access to workspace." }, "GetPermissionSelectedAsync": { "title": "GetPermissionSelectedAsync", "required": [ "permissions" ], "properties": { "permissions": { "type": "array", "items": {}, "description": "Collection of Permission references." } }, "description": "Indicates a given permission is selected. (ArtifactTypeID)" }, "GetPermissionSelectedListAsync": { "title": "GetPermissionSelectedListAsync", "required": [ "permissions", "artifactIDs" ], "properties": { "permissions": { "type": "array", "items": {}, "description": "Collection of Permission references." }, "artifactIDs": { "type": "array", "items": { "type": "integer", "format": "System.Int32" }, "description": "Collection of Artifact IDs." } }, "description": "Returns the current user’s permission to the specified relativity artifacts as a dictionary that maps the ArtifactID to the permissions values. \r\n Inputs include the workspace ArtifactID, a collection of PermissionRef objects, and a collection of ArtifactIDs. \r\n To return admin-level artifact permissions, specify -1 as the workspace ArtifactID." }, "GetPermissionSelectedForGroupAsync": { "title": "GetPermissionSelectedForGroupAsync", "required": [ "permissions" ], "properties": { "permissions": { "type": "array", "items": {}, "description": "Collection of Permission references." } }, "description": "Indicates a given permission is selected. (ArtifactTypeID for a given Group)" }, "GetAdminOperationPermissionSelectedListAsync": { "title": "GetAdminOperationPermissionSelectedListAsync", "required": [ "permissionIDs" ], "properties": { "permissionIDs": { "type": "array", "items": { "type": "integer", "format": "System.Int32" }, "description": "Collection of Permission identifiers." } }, "description": "Indicates if a given admin permission is selected." }, "GetGroupTabVisibilityAsync": { "title": "GetGroupTabVisibilityAsync", "description": "Get a list of tabs for the group and the tab visibility state." }, "SetGroupTabVisibilityAsync": { "title": "SetGroupTabVisibilityAsync", "required": [ "tabVisibility" ], "properties": { "tabVisibility": { "type": "array", "items": {}, "description": "The tab visibility state." } }, "description": "Update the tab visibility state for a group." }, "QueryGroupsByUserAsync": { "title": "QueryGroupsByUserAsync", "required": [ "request", "start", "length" ], "properties": { "request": { "title": "QueryRequest", "required": [ "ObjectType", "Condition", "Sorts", "RelationalField", "RowCondition", "SearchProviderCondition", "SampleParameters", "IncludeIDWindow", "RankSortOrder", "QueryHint", "Fields", "IsAdhocQuery", "ConvertNumberFieldValuesToString", "IncludeNameInQueryResult", "ExecutingSavedSearchID", "ExecutingViewID", "ActiveArtifactID", "MaxCharactersForLongTextValues", "LongTextBehavior" ], "type": "object", "properties": { "ObjectType": { "required": [ "ArtifactID", "Name", "Guid", "ArtifactTypeID" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ArtifactTypeID": { "type": "integer", "description": "", "format": "System.Int32" } } }, "Condition": { "type": "string", "description": "", "format": "System.String" }, "Sorts": { "type": "array", "items": {}, "description": "" }, "RelationalField": { "required": [ "ViewFieldID", "ArtifactID", "Guid", "Name" ], "type": "object", "properties": { "ViewFieldID": { "type": "integer", "description": "", "format": "System.Int32" }, "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "RowCondition": { "type": "string", "description": "", "format": "System.String" }, "SearchProviderCondition": { "required": [ "SearchIndex", "Input" ], "type": "object", "properties": { "SearchIndex": { "required": [ "ArtifactID", "Name" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "Input": { "type": "string", "description": "", "format": "System.String" } } }, "SampleParameters": { "required": [ "ExistingToken", "MarginOfError", "ConfidenceLevel", "FixedSampleSize", "SamplingPercentage" ], "type": "object", "properties": { "ExistingToken": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MarginOfError": { "type": "number", "description": "", "format": "System.Decimal" }, "ConfidenceLevel": { "type": "number", "description": "", "format": "System.Decimal" }, "FixedSampleSize": { "type": "integer", "description": "", "format": "System.Int32" }, "SamplingPercentage": { "type": "number", "description": "", "format": "System.Decimal" } } }, "IncludeIDWindow": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "RankSortOrder": { "type": "nullable`1[[relativity.identity.server.v1.shared.sortenum, relativity.identity.server, version=11.3.0.0, culture=neutral, publickeytoken=null]]", "description": "", "format": "System.Nullable`1[[Relativity.Identity.Server.V1.Shared.SortEnum, Relativity.Identity.Server, Version=11.3.0.0, Culture=neutral, PublicKeyToken=null]]" }, "QueryHint": { "type": "string", "description": "", "format": "System.String" }, "Fields": { "type": "array", "items": {}, "description": "" }, "IsAdhocQuery": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ConvertNumberFieldValuesToString": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "IncludeNameInQueryResult": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingSavedSearchID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingViewID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ActiveArtifactID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MaxCharactersForLongTextValues": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "LongTextBehavior": { "type": "object" } }, "additionalProperties": false, "description": "A QueryRequest object containing conditions, sorting order, fields and other information for the query." }, "start": { "type": "integer", "description": "Index of the first artifact in the returned QueryResultSet object.", "format": "integer" }, "length": { "type": "integer", "description": "Number of items to return in the query result, starting with index in the start parameter.", "format": "integer" } }, "description": "" }, "QueryEligibleGroupsToAddUsersToAsync": { "title": "QueryEligibleGroupsToAddUsersToAsync", "required": [ "request", "start", "length", "users" ], "properties": { "request": { "title": "QueryRequest", "required": [ "ObjectType", "Condition", "Sorts", "RelationalField", "RowCondition", "SearchProviderCondition", "SampleParameters", "IncludeIDWindow", "RankSortOrder", "QueryHint", "Fields", "IsAdhocQuery", "ConvertNumberFieldValuesToString", "IncludeNameInQueryResult", "ExecutingSavedSearchID", "ExecutingViewID", "ActiveArtifactID", "MaxCharactersForLongTextValues", "LongTextBehavior" ], "type": "object", "properties": { "ObjectType": { "required": [ "ArtifactID", "Name", "Guid", "ArtifactTypeID" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ArtifactTypeID": { "type": "integer", "description": "", "format": "System.Int32" } } }, "Condition": { "type": "string", "description": "", "format": "System.String" }, "Sorts": { "type": "array", "items": {}, "description": "" }, "RelationalField": { "required": [ "ViewFieldID", "ArtifactID", "Guid", "Name" ], "type": "object", "properties": { "ViewFieldID": { "type": "integer", "description": "", "format": "System.Int32" }, "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "RowCondition": { "type": "string", "description": "", "format": "System.String" }, "SearchProviderCondition": { "required": [ "SearchIndex", "Input" ], "type": "object", "properties": { "SearchIndex": { "required": [ "ArtifactID", "Name" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "Input": { "type": "string", "description": "", "format": "System.String" } } }, "SampleParameters": { "required": [ "ExistingToken", "MarginOfError", "ConfidenceLevel", "FixedSampleSize", "SamplingPercentage" ], "type": "object", "properties": { "ExistingToken": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MarginOfError": { "type": "number", "description": "", "format": "System.Decimal" }, "ConfidenceLevel": { "type": "number", "description": "", "format": "System.Decimal" }, "FixedSampleSize": { "type": "integer", "description": "", "format": "System.Int32" }, "SamplingPercentage": { "type": "number", "description": "", "format": "System.Decimal" } } }, "IncludeIDWindow": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "RankSortOrder": { "type": "nullable`1[[relativity.identity.server.v1.shared.sortenum, relativity.identity.server, version=11.3.0.0, culture=neutral, publickeytoken=null]]", "description": "", "format": "System.Nullable`1[[Relativity.Identity.Server.V1.Shared.SortEnum, Relativity.Identity.Server, Version=11.3.0.0, Culture=neutral, PublicKeyToken=null]]" }, "QueryHint": { "type": "string", "description": "", "format": "System.String" }, "Fields": { "type": "array", "items": {}, "description": "" }, "IsAdhocQuery": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ConvertNumberFieldValuesToString": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "IncludeNameInQueryResult": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingSavedSearchID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingViewID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ActiveArtifactID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MaxCharactersForLongTextValues": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "LongTextBehavior": { "type": "object" } }, "additionalProperties": false, "description": "A QueryRequest object containing conditions, sorting order, fields and other information for the query." }, "start": { "type": "integer", "description": "Index of the first artifact in the returned QueryResultSet object.", "format": "integer" }, "length": { "type": "integer", "description": "Number of items to return in the query result, starting with index in the start parameter.", "format": "integer" }, "users": { "type": "array", "items": {}, "description": "A list of User identifiers." } }, "description": "Query for Groups that are eligible for adding at least one of specified users." }, "ReadSettingsAsync": { "title": "ReadSettingsAsync", "description": "Retrieves settings for the current user, including their name, email, and other properties." }, "UpdateSettingsAsync": { "title": "UpdateSettingsAsync", "required": [ "userSettingRequest" ], "properties": { "userSettingRequest": { "title": "UserSettingRequest", "required": [ "DefaultFilterVisibility", "DefaultSelectedFileType", "EmailAddress", "EmailPreference", "FirstName", "ItemListPageLength", "LastName", "SavedSearchDefaultsToPublic", "SkipDefaultPreference" ], "type": "object", "properties": { "DefaultFilterVisibility": { "type": "boolean", "description": "", "format": "System.Boolean" }, "DefaultSelectedFileType": { "type": "object" }, "EmailAddress": { "type": "string", "description": "", "format": "System.String" }, "EmailPreference": { "type": "object" }, "FirstName": { "type": "string", "description": "", "format": "System.String" }, "ItemListPageLength": { "type": "integer", "description": "", "format": "System.Int32" }, "LastName": { "type": "string", "description": "", "format": "System.String" }, "SavedSearchDefaultsToPublic": { "type": "boolean", "description": "", "format": "System.Boolean" }, "SkipDefaultPreference": { "type": "boolean", "description": "", "format": "System.Boolean" } }, "additionalProperties": false, "description": "The data about the user settings being updated." } }, "description": "Modifies the user setting properties of the current user." }, "GetAvailableTypesAsync": { "title": "GetAvailableTypesAsync", "description": "Gets all possible types for the User" }, "RetrieveAll": { "title": "RetrieveAll", "description": "Gets a list of all users and their information for a given workspace." }, "RetrieveUsersBy": { "title": "RetrieveUsersBy", "required": [ "query", "start", "length" ], "properties": { "query": { "title": "QueryRequest", "required": [ "ObjectType", "Condition", "Sorts", "RelationalField", "RowCondition", "SearchProviderCondition", "SampleParameters", "IncludeIDWindow", "RankSortOrder", "QueryHint", "Fields", "IsAdhocQuery", "ConvertNumberFieldValuesToString", "IncludeNameInQueryResult", "ExecutingSavedSearchID", "ExecutingViewID", "ActiveArtifactID", "MaxCharactersForLongTextValues", "LongTextBehavior" ], "type": "object", "properties": { "ObjectType": { "required": [ "ArtifactID", "Name", "Guid", "ArtifactTypeID" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ArtifactTypeID": { "type": "integer", "description": "", "format": "System.Int32" } } }, "Condition": { "type": "string", "description": "", "format": "System.String" }, "Sorts": { "type": "array", "items": {}, "description": "" }, "RelationalField": { "required": [ "ViewFieldID", "ArtifactID", "Guid", "Name" ], "type": "object", "properties": { "ViewFieldID": { "type": "integer", "description": "", "format": "System.Int32" }, "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Guid": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "RowCondition": { "type": "string", "description": "", "format": "System.String" }, "SearchProviderCondition": { "required": [ "SearchIndex", "Input" ], "type": "object", "properties": { "SearchIndex": { "required": [ "ArtifactID", "Name" ], "type": "object", "properties": { "ArtifactID": { "type": "integer", "description": "", "format": "System.Int32" }, "Name": { "type": "string", "description": "", "format": "System.String" } } }, "Input": { "type": "string", "description": "", "format": "System.String" } } }, "SampleParameters": { "required": [ "ExistingToken", "MarginOfError", "ConfidenceLevel", "FixedSampleSize", "SamplingPercentage" ], "type": "object", "properties": { "ExistingToken": { "type": "nullable`1[[system.guid, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MarginOfError": { "type": "number", "description": "", "format": "System.Decimal" }, "ConfidenceLevel": { "type": "number", "description": "", "format": "System.Decimal" }, "FixedSampleSize": { "type": "integer", "description": "", "format": "System.Int32" }, "SamplingPercentage": { "type": "number", "description": "", "format": "System.Decimal" } } }, "IncludeIDWindow": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "RankSortOrder": { "type": "nullable`1[[relativity.identity.server.v1.shared.sortenum, relativity.identity.server, version=11.3.0.0, culture=neutral, publickeytoken=null]]", "description": "", "format": "System.Nullable`1[[Relativity.Identity.Server.V1.Shared.SortEnum, Relativity.Identity.Server, Version=11.3.0.0, Culture=neutral, PublicKeyToken=null]]" }, "QueryHint": { "type": "string", "description": "", "format": "System.String" }, "Fields": { "type": "array", "items": {}, "description": "" }, "IsAdhocQuery": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ConvertNumberFieldValuesToString": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "IncludeNameInQueryResult": { "type": "nullable`1[[system.boolean, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingSavedSearchID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ExecutingViewID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "ActiveArtifactID": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "MaxCharactersForLongTextValues": { "type": "nullable`1[[system.int32, mscorlib, version=4.0.0.0, culture=neutral, publickeytoken=b77a5c561934e089]]", "description": "", "format": "System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]" }, "LongTextBehavior": { "type": "object" } }, "additionalProperties": false, "description": "A QueryRequest object containing conditions, sorting order, and other information for the query." }, "start": { "type": "integer", "description": "Index of the first artifact in the returned UserInfoQueryResultSet object.", "format": "integer" }, "length": { "type": "integer", "description": "Number of items to return in the query result, starting with index in the start parameter.", "format": "integer" } }, "description": "Gets a list of users and their information, and supports filtering, ordering, and paging these results." }, "RetrieveCurrentAsync": { "title": "RetrieveCurrentAsync", "description": "Asynchronously retrieves the current user in the specified workspace. NOTE: User Artifact ID may differ for the same user in different workspaces." }, "ReadAllUsersAsync": { "title": "ReadAllUsersAsync", "description": "Asynchronously retrieves a list of all users in a workspace, including administrators and (optional) deleted users." }, "ReadActiveUsersAsync": { "title": "ReadActiveUsersAsync", "description": "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." }, "RetrieveAllWithRelativityAccessAsync": { "title": "RetrieveAllWithRelativityAccessAsync", "description": "" } }, "parameters": { "X-CSRF-Header": { "name": "X-CSRF-Header", "in": "header", "description": "Required CSRF header for any KeplerService. *Note: Actual string value does not matter*. ", "required": true, "schema": { "type": "string", "format": "System.String", "default": "." } }, "federatedInstanceName": { "name": "federatedInstanceName", "in": "path", "description": "The name of the Federated Instance to read", "required": true, "schema": { "type": "string" } }, "clientID": { "name": "clientID", "in": "path", "description": "The ClientID of the OAuth2 Client to read.", "required": true, "schema": { "type": "string" } }, "name": { "name": "name", "in": "path", "description": "The name of the Provider Type", "required": true, "schema": { "type": "string" } }, "groupID": { "name": "groupID", "in": "path", "description": "The Artifact ID of the user group.", "required": true, "schema": { "type": "integer" } }, "includeMetadata": { "name": "includeMetadata", "in": "path", "description": "A Boolean value indicating whether to return extended group metadata in the response.", "required": true, "schema": { "type": "boolean" } }, "includeActions": { "name": "includeActions", "in": "path", "description": "A Boolean value indicating whether to return a list of operations available to the user for this user group.", "required": true, "schema": { "type": "boolean" } }, "userID": { "name": "userID", "in": "path", "description": "The user id", "required": true, "schema": { "type": "integer" } }, "workspaceArtifactID": { "name": "workspaceArtifactID", "in": "path", "description": "Workspace ArtifactID.", "required": true, "schema": { "type": "integer" } }, "artifactID": { "name": "artifactID", "in": "path", "description": "Item ArtifactID.", "required": true, "schema": { "type": "integer" } }, "length": { "name": "length", "in": "path", "description": "Number of results to return.", "required": true, "schema": { "type": "integer" } }, "queryToken": { "name": "queryToken", "in": "path", "description": "Search Query Token, obtained from the Query Result.", "required": true, "schema": { "type": "string" } }, "start": { "name": "start", "in": "path", "description": "Starting index for this query.", "required": true, "schema": { "type": "integer" } }, "permissionID": { "name": "permissionID", "in": "path", "description": "ID of the Permission to Read.", "required": true, "schema": { "type": "integer" } }, "groupArtifactID": { "name": "groupArtifactID", "in": "path", "description": "The group artifactID.", "required": true, "schema": { "type": "integer" } }, "workspaceID": { "name": "workspaceID", "in": "path", "description": "The ArtifactID of the workspace used to retrieve a list of all users. Use -1 to retrieve users from the admin-level context.", "required": true, "schema": { "type": "integer" } }, "includeDeleted": { "name": "includeDeleted", "in": "path", "description": "[Optional - Default false] Include Users flagged as deleted in the results", "required": true, "schema": { "type": "boolean" } }, "includeCurrentUser": { "name": "includeCurrentUser", "in": "path", "description": "[Optional - Default true] Include the current user in the results; False would be for instances like coding docs", "required": true, "schema": { "type": "boolean" } }, "enforceChoiceLimitForUI": { "name": "enforceChoiceLimitForUI", "in": "path", "description": "If the list exceeds configured limit of users, no users will be returned.", "required": true, "schema": { "type": "boolean" } } } }, "tags": [ { "name": "Relativity.Identity.Server.V1.Services.Interfaces.IFederatedInstanceManager", "description": "Connect this local Relativity instance to one or more remote Relativity instances for the\r\n purposes of navigation and data exchange." }, { "name": "Relativity.Identity.Server.V1.Services.Interfaces.IOAuth2ClientManager", "description": "Service for managing OAuth2 Clients" }, { "name": "Relativity.Identity.Server.V1.Services.Interfaces.IAuthProviderTypeManager", "description": "Web services for interacting with Authentication Provider Types" }, { "name": "Relativity.Identity.Server.V1.Services.Interfaces.IGroupManager", "description": "Provides methods to interact with groups at the admin level" }, { "name": "Relativity.Identity.Server.V1.Services.Interfaces.ILoginProfileManager", "description": "Service for managing login methods that are configured for individual users." }, { "name": "Relativity.Identity.Server.V1.Services.Interfaces.IPermissionManager", "description": "Permission Manager." }, { "name": "Relativity.Identity.Server.V1.Services.Interfaces.IUserManager", "description": "Service for managing Relativity Users" } ] }