OneTrust Privacy Notice V2 API

openapi: 3.2.0
info:
  title: Consent & Preferences - Policy & Notice Management Privacy…
  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
  description: The Policy & Notice Management APIs are used to list privacy notices, page through results, view version history for a notice, and retrieve the version that was effective at a specific date and time.
servers:
- url: https://{hostname}/api/privacynotice
  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: Privacy Notice V2
  description: APIs used to list privacy notices, fetch versions for a notice, and get the notice version active on a given date/time.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/consent-preferences-policy-notice-management.json
paths:
  /v2/privacynotices:
    get:
      operationId: getPrivacyNoticesUsingGET
      summary: Get List of Privacy Notices
      description: Use this API to retrieve a list of all privacy notices. The response will include details for each privacy notice along with the corresponding privacy notice ID, created date, and last published date.
      tags:
      - Privacy Notice V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/consent-preferences-policy-notice-management.json
      parameters:
      - name: page
        in: query
        schema:
          description: Results page to be retrieved (0..N). Example- '?page=1
          type: integer
          format: int32
          default: 0
          maximum: 49
          minimum: 0
        example: 1
      - name: size
        in: query
        schema:
          description: Number of records per page (1..50). Example- '?size=30
          type: integer
          format: int32
          default: 20
          maximum: 50
          minimum: 1
        example: 50
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PrivacyNoticeDtoV2'
        '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:
            ot-ratelimit-event-id:
              style: simple
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            Retry-After:
              style: simple
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-requests-allowed:
              style: simple
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
            ot-period:
              style: simple
              schema:
                description: The unit of time for which the rate limit applies.
                enum:
                - HOUR
                - MINUTE
            ot-request-made:
              style: simple
              schema:
                description: The number of requests made within the specified period.
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagePrivacyNoticeDtoV2'
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - GENERIC
        - POLICY
  /v2/privacynotices/{id}:
    get:
      operationId: getPrivacyNoticeVersionByPublishedDateUsingGET
      summary: Get Privacy Notice Version
      description: Use this API to retrieve a specific version of the privacy notice by the published date and time. The response will return details on the version of the privacy notice that was most recently published before the value specified in the `date` parameter.
      tags:
      - Privacy Notice V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/consent-preferences-policy-notice-management.json
      parameters:
      - name: id
        in: path
        required: true
        schema:
          description: UUID of the Privacy Notice. The value can be obtained using [Get List of Privacy Notices](/onetrust/reference/getprivacynoticesusingget) API.
          type: string
          format: uuid
      - name: date
        in: query
        required: true
        schema:
          description: 'Date and time to fetch the version. Accepted formats: yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.'
          type: string
          pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}(T[0-9]{2}:[0-9]{2}:[0-9]{2})?$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivacyNoticeWithVersionDtoV2'
        '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:
            ot-ratelimit-event-id:
              style: simple
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            Retry-After:
              style: simple
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-requests-allowed:
              style: simple
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
            ot-period:
              style: simple
              schema:
                description: The unit of time for which the rate limit applies.
                enum:
                - HOUR
                - MINUTE
            ot-request-made:
              style: simple
              schema:
                description: The number of requests made within the specified period.
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PrivacyNoticeWithVersionDtoV2'
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - GENERIC
        - POLICY
  /v2/privacynotices/{privacyNoticeId}/versions:
    get:
      operationId: getPrivacyNoticeVersionsUsingGET
      summary: Get List of Privacy Notice Versions
      description: Use this API to retrieve a list of versions for a specific privacy notice.
      tags:
      - Privacy Notice V2
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/consent-preferences-policy-notice-management.json
      parameters:
      - name: privacyNoticeId
        in: path
        required: true
        schema:
          description: ID of the privacy notice. The value can be obtained using [Get List of Privacy Notices](/onetrust/reference/getprivacynoticesusingget) API.
          type: string
          format: uuid
      - name: page
        in: query
        schema:
          description: Results page to be retrieved (0..N). Example- '?page=1
          type: integer
          format: int32
          default: 0
          maximum: 49
          minimum: 0
        example: 1
      - name: size
        in: query
        schema:
          description: Number of records per page (1..50). Example- '?size=30
          type: integer
          format: int32
          default: 20
          maximum: 50
          minimum: 1
        example: 50
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PrivacyNoticeVersionDetailsDtoV2'
        '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:
            ot-ratelimit-event-id:
              style: simple
              schema:
                description: The unique identifier for the rate-limiting event.
                format: uuid
            Retry-After:
              style: simple
              schema:
                description: The number of seconds after which requests will be allowed again.
                format: int32
            ot-requests-allowed:
              style: simple
              schema:
                description: The number of requests allowed within the specified period.
                format: int32
            ot-period:
              style: simple
              schema:
                description: The unit of time for which the rate limit applies.
                enum:
                - HOUR
                - MINUTE
            ot-request-made:
              style: simple
              schema:
                description: The number of requests made within the specified period.
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagePrivacyNoticeVersionDetailsDtoV2'
        '500':
          description: Internal Server Error
      security:
      - OAUTH2:
        - GENERIC
        - POLICY
components:
  schemas:
    PrivacyNoticeWithVersionDtoV2:
      type: object
      properties:
        id:
          description: Unique Identifier identifying a Privacy Notice
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b431
        createdDate:
          description: The Date Privacy Notice was created on
          type: string
          format: date-time
          example: '2020-04-26T16:10:24.479'
        lastPublishedDate:
          description: The date Privacy Notice was published on
          type: string
          format: date-time
          example: '2020-04-27T16:10:24.479'
        organizationId:
          description: Unique Identifier of the Organization Privacy Notice belongs to
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b430
        responsibleUserId:
          description: Unique Identifier identifying a Responsible User of the Privacy Notice
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b435
        version:
          description: Version of the privacy notice which was active at the given date and time
          $ref: '#/components/schemas/PrivacyNoticeVersionDtoV2'
    PageableObject:
      type: object
      properties:
        offset:
          type: integer
          format: int64
        sort:
          $ref: '#/components/schemas/SortObject'
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        paged:
          type: boolean
        unpaged:
          type: boolean
    PagePrivacyNoticeVersionDetailsDtoV2:
      type: object
      properties:
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        content:
          items:
            $ref: '#/components/schemas/PrivacyNoticeVersionDetailsDtoV2'
          type: array
        number:
          type: integer
          format: int32
        sort:
          $ref: '#/components/schemas/SortObject'
        first:
          type: boolean
        last:
          type: boolean
        numberOfElements:
          type: integer
          format: int32
        pageable:
          $ref: '#/components/schemas/PageableObject'
        empty:
          type: boolean
    PrivacyNoticeLanguageDetailsDtoV2:
      type: object
      properties:
        guid:
          description: Unique Identifier identifying a Notice Version Language
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b432
        languageCode:
          description: Language Code of the Notice Version
          type: string
          example: en-us
        defaultLanguage:
          description: Default Language of the Notice Version
          type: boolean
          example: true
    PrivacyNoticeDtoV2:
      type: object
      properties:
        id:
          description: Unique Identifier identifying a Privacy Notice
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b431
        createdDate:
          description: The Date Privacy Notice was created on
          type: string
          format: date-time
          example: '2020-04-20T16:11:25.479'
        lastPublishedDate:
          description: The date Privacy Notice was published on
          type: string
          format: date-time
          example: '2020-05-14T00:00:48.62'
        organizationId:
          description: Unique Identifier identifying a Organization of the Privacy Notice
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b430
        responsibleUserId:
          description: Unique Identifier identifying a Responsible User of the Privacy Notice
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b435
        numberOfVersions:
          description: Total number of version in Privacy Notice
          type: integer
          format: int64
          example: 2
        versions:
          description: All Verisons of the Privacy Notice
          type: array
          items:
            $ref: '#/components/schemas/PrivacyNoticeVersionDetailDtoV2'
    PagePrivacyNoticeDtoV2:
      type: object
      properties:
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        content:
          items:
            $ref: '#/components/schemas/PrivacyNoticeDtoV2'
          type: array
        number:
          type: integer
          format: int32
        sort:
          $ref: '#/components/schemas/SortObject'
        first:
          type: boolean
        last:
          type: boolean
        numberOfElements:
          type: integer
          format: int32
        pageable:
          $ref: '#/components/schemas/PageableObject'
        empty:
          type: boolean
    PrivacyNoticeVersionDtoV2:
      type: object
      properties:
        id:
          description: Unique Identifier identifying a Privacy Notice Version
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b400
        name:
          description: Name of the Privacy Notice
          type: string
          example: California Privacy Policy
          maxLength: 200
          minLength: 1
        publishedDate:
          description: The date Privacy Notice version was published on
          type: string
          format: date-time
          example: '2020-05-14T00:00:48.62'
        status:
          description: The Status of Privacy Notice Version
          type: string
          example: ACTIVE
          enum:
          - ACTIVE
          - DRAFT
          - RETIRED
          - INACTIVE
        version:
          description: The Version of Privacy Notice
          type: integer
          format: int64
          example: 3
    PrivacyNoticeVersionDetailsDtoV2:
      type: object
      properties:
        id:
          description: Unique Identifier identifying a Notice Version
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b432
        name:
          description: Name of the Notice Version
          type: string
          example: General Privacy Act
          maxLength: 200
          minLength: 1
        status:
          description: Status of the Notice Version
          example: ACTIVE
          $ref: '#/components/schemas/PrivacyNoticeVersionStatus'
        version:
          description: Version number of the Notice Version
          type: integer
          format: int64
          example: 1
        publishedDate:
          description: Published Date of Notice Version
          type: string
          format: date-time
          example: '2020-05-14T00:00:48.62'
        publishedBy:
          description: Publisher of the Notice Version
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b435
        languages:
          description: Languages Supported by Notice Version
          type: array
          items:
            $ref: '#/components/schemas/PrivacyNoticeLanguageDetailsDtoV2'
    SortObject:
      type: object
      properties:
        empty:
          type: boolean
        sorted:
          type: boolean
        unsorted:
          type: boolean
    PrivacyNoticeVersionStatus:
      type: string
      example: ACTIVE
      enum:
      - ACTIVE
      - DRAFT
      - RETIRED
      - INACTIVE
    PrivacyNoticeVersionDetailDtoV2:
      type: object
      properties:
        id:
          description: Unique Identifier identifying a Privacy Notice Version
          type: string
          format: uuid
          example: 625ba071-61b0-485f-81a0-a2245777b400
        publishedDate:
          description: The date Privacy Notice version was published on
          type: string
          format: date-time
          example: '2020-05-14T00:00:48.62'
        status:
          description: The Status of Privacy Notice Version
          type: string
          enum:
          - ACTIVE
          - DRAFT
          - RETIRED
          - INACTIVE
        version:
          description: The Version of Privacy Notice
          type: integer
          format: int64
          example: 1
  securitySchemes:
    OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            POLICY: Policy scope for external systems
x-onetrust:
  spec-label: OpenAPI 3.1.0
  links:
  - '{''Policy & Notice Management Knowledge Base'': ''https://my.onetrust.com/s/topic/0TO3q000000kIWPGA2/policy-notice-management''}'
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false