OneTrust Entity Types API

openapi: 3.2.0
info:
  title: Tech Risk & Compliance - IT Risk Management Entity Types API
  description: The IT Risk Management API provides comprehensive REST endpoints for managing enterprise security controls, threats, vulnerabilities, and their implementations with OAuth2 security and extensive customization capabilities.
  version: '1.0'
  contact:
    name: OneTrust Support
    url: https://my.onetrust.com/s/contactsupport
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://{hostname}
  variables:
    hostname:
      default: hostname
      description: The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com.
tags:
- name: Entity Types
  description: APIs to manage risk entity types and source entity types, including retrieval of enabled entity configurations for risk associations.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-it-risk-management.json
  x-displayName: Entity Types
paths:
  /api/risk/v2/risks/risk-entity-types:
    get:
      operationId: getAllEnabledRiskEntityTypesUsingGET
      summary: Get List of Risk Entity Types
      description: Use this API to retrieve a list of all entity types from which a risk can be created.
      tags:
      - Entity Types
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-it-risk-management.json
      responses:
        '200':
          description: Successful retrieval of risk entity types
          content:
            application/json:
              schema:
                type: array
                $ref: '#/components/schemas/TechRiskCompliance-Risk_EntityTypeInformation'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - TechRiskCompliance-Risk_OAUTH2:
        - INTEGRATION
        - RISK
        - RISK_READ
  /api/risk/v2/risks/source-entity-types:
    get:
      operationId: getAllEnabledSourceEntityTypesUsingGET
      summary: Get List of Risk Entity Source Types
      description: Use this API to retrieve a list of all entity types that can be automatically assigned as the source of a risk.
      tags:
      - Entity Types
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/tech-risk-compliance-it-risk-management.json
      responses:
        '200':
          description: Successful retrieval of source entity types
          content:
            application/json: {}
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TechRiskCompliance-Risk_EntityTypeInformation'
        '403':
          description: Forbidden
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TechRiskCompliance-Risk_EntityTypeInformation'
        '429':
          description: "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview)."
          headers:
            Retry-After:
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-period:
              schema:
                description: The unit of time for which the rate limit applies
                enum:
                - HOUR
                - MINUTE
            ot-ratelimit-event-id:
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            ot-request-made:
              schema:
                description: The number of requests made within the specified period.
                format: int32
            ot-requests-allowed:
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
        '500':
          description: Internal Server Error
      security:
      - TechRiskCompliance-Risk_OAUTH2:
        - INTEGRATION
        - RISK
        - RISK_READ
components:
  schemas:
    TechRiskCompliance-Risk_EntityTypeInformation:
      type: object
      properties:
        id:
          description: Entity Type ID. This can be Assets, Entities, PIA, Engagement, Custom Object GUID in form of String.
          type: string
          example: 3f99b4ac-7c66-45b6-8ff4-63a67a3ec7be
        label:
          description: Entity Type Name
          type: string
          example: Inventory
          maxLength: 512
        translationKey:
          description: Translation Key of Entity Type ID
          type: string
          example: OBJ.Objective
          maxLength: 255
        seeded:
          description: For Base Entity Type Seeded is true and false for Custom Object/Entity Types by default.
          type: boolean
          example: false
        sourceType:
          description: Indicates whether this type can be source type or not in Risk
          type: boolean
          example: false
        riskType:
          description: Indicates whether this type can be risk type or not in Risk
          type: boolean
          example: true
        eligibleForEntityLink:
          description: Indicates whether entity type is eligible for linking/relating with risk or not
          type: boolean
          example: false
        enabled:
          description: Indicates whether the entity type is enabled or not.
          type: boolean
          example: false
        moduleName:
          description: Name of the module
          type: string
          example: Objective
          maxLength: 255
      required:
      - id
  securitySchemes:
    TechRiskCompliance-ITRiskManagement_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            CONTROL: Access to Control Implementation operations for external systems
            ITRM: Access to ITRM operations for external systems
    TechRiskCompliance-RiskTemplate_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            INTEGRATION: Integration Scope
            RISK: Risk Scope
            RISK_READ: Risk read scope
    TechRiskCompliance-Risk_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            RISK: Risk Scope
            RISK_READ: Risk read scope
            INTEGRATION: Integration scope
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false
x-onetrust:
  spec-label: OpenAPI 3.1.0