Relativity Identity Module v1 API

openapi: 3.0.1
info:
  title: Analytics.Conceptual.Service.Interfaces.Public.V1 AnnotationService Identity Module v1 API
  description: Analytics.Conceptual.Service.Interfaces.Public
  version: V1
servers:
- url: /Relativity.REST/api
  description: The URL prefix for all Kepler services
tags:
- name: Identity Module v1
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 <see cref="T:Relativity.Identity.Server.V1.Shared.MassOperationResult" />.
    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 <see cref="T:Relativity.Identity.Server.V1.Shared.MassOperationResult" />.
  /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

# --- truncated at 32 KB (151 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relativity/refs/heads/main/openapi/relativity-identity-module-v1-api-openapi.yml