OneTrust Magic Link Tokens API

openapi: 3.2.0
info:
  title: Consent & Preferences - Universal Consent & Preference…
  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 Universal Consent & Preference Management APIs are used to integrate external systems and streamline the flow of data with Universal Consent & Preference Management in the OneTrust Platform.
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: Magic Link Tokens
  description: The Magic Link Tokens APIs are used to generate secure, one-time-use links for authentication.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json
  x-displayName: Magic Link Tokens
paths:
  /api/consentmanager/v1/linktokens:
    get:
      operationId: getLinkTokensUsingGET
      summary: Get List of Data Subject Tokens
      description: Use this API to retrieve a list of link tokens. The response will return link tokens along with the corresponding data subject ID, created date, and expiry date. By default, the response will return link token details sorted in ascending order of created date.
      tags:
      - Magic Link Tokens
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json
      parameters:
      - name: since
        in: query
        description: Date from which to return records. Formats accepted yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.
        required: false
        schema:
          type: string
          format: date-time
          example: '2023-01-01T00:00:00'
      - name: until
        in: query
        description: Date to which to return records. Formats accepted yyyy-MM-dd or yyyy-MM-ddTHH:mm:ss.
        required: false
        schema:
          type: string
          format: date-time
          example: '2023-12-31T23:59:59'
      - name: identifier
        in: header
        description: Identifier of the Data Subject for which you want to retrieve the Email Link Token.
        required: false
        schema:
          type: string
          example: user@example.com
      - name: page
        in: query
        description: Results page you want to retrieve (0..N).
        schema:
          type: integer
          example: 0
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        schema:
          type: integer
          example: 20
          default: 20
          maximum: 2000
          minimum: 1
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        schema:
          type: string
          example: createdDate,desc
          enum:
          - id,asc
          - id,desc
          - tokenId,asc
          - tokenId,desc
          - expiryDate,asc
          - expiryDate,desc
          - createdDate,asc
          - createdDate,desc
          - lastModifiedDate,asc
          - lastModifiedDate,desc
          - createdBy,asc
          - createdBy,desc
          - lastModifiedBy,asc
          - lastModifiedBy,desc
          - dataSubject.guid,asc
          - dataSubject.guid,desc
          - dataSubject.identifier,asc
          - dataSubject.identifier,desc
      responses:
        '200':
          description: OK - Successfully retrieved link tokens.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageLinkTokenDto'
        '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:
      - ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2:
        - CONSENT
        - CONSENT_READ
components:
  schemas:
    ConsentPreferences-UniversalConsentPreferenceManag_LinkTokenDto:
      properties:
        DataSubjectId:
          description: The unique identifier of the Data Subject (e.g., email address)
          type: string
          example: example@otprivacy.com
        LinkToken:
          description: The secure token used to authenticate the Data Subject in the Preference Center
          type: string
          example: jNJW2e8vm8eWb6DlWyGbZ/7PsfC+AHFN8JqvZHPGzJQ=
        UrlEncodedLinkToken:
          description: URL-encoded version of the link token for use in URLs
          type: string
          example: jNJW2e8vm8eWb6DlWyGbZ%2F7PsfC%2BAHFN8JqvZHPGzJQ%3D
        ExpiryDate:
          description: The date and time when the link token will expire
          type: string
          format: date-time
          example: '2023-12-31T23:59:59.999Z'
        CreatedDate:
          description: The date and time when the link token was created
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
      required:
      - DataSubjectId
      - LinkToken
    ConsentPreferences-UniversalConsentPreferenceManag_SortObject:
      properties:
        empty:
          type: boolean
        sorted:
          type: boolean
        unsorted:
          type: boolean
    ConsentPreferences-UniversalConsentPreferenceManag_PageableObject:
      properties:
        offset:
          type: integer
          format: int64
        sort:
          $ref: '#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject'
        pageNumber:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        paged:
          type: boolean
        unpaged:
          type: boolean
    ConsentPreferences-UniversalConsentPreferenceManag_PageLinkTokenDto:
      type: object
      properties:
        content:
          description: The list of items for the current page.
          items:
            $ref: '#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_LinkTokenDto'
          type: array
        empty:
          description: The flag to check if the entity is empty or not.
          type: boolean
          example: false
        first:
          description: The flag to check if the entity is first entity or not.
          type: boolean
          example: true
        last:
          description: The flag to check if the entity is last entity or not.
          type: boolean
          example: false
        number:
          description: The number associated with the result.
          type: integer
          format: int32
          example: 0
        numberOfElements:
          description: Total number of elements in the result.
          type: integer
          format: int32
          example: 20
        pageable:
          $ref: '#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_PageableObject'
        sort:
          $ref: '#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_SortObject'
        totalPages:
          description: Total number of pages in the result list.
          type: integer
          format: int32
          example: 5
        totalElements:
          description: Total number of elements in the result.
          type: integer
          format: int64
          example: 50
        size:
          description: Size of the result list.
          type: integer
          format: int32
          example: 20
  securitySchemes:
    ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            CONSENT: Consent Scope gives the user access to read/write operations
            CONSENT_READ: Consent Read Scope gives the user read-only access
    ConsentAPI_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            CONSENT: Consent Scope gives the user access to read/write operations
            CONSENT_READ: Consent Read Scope gives the user read-only access
    DSPreferneceCache_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            CONSENT: Consent Scope gives the user access to read/write operations
            CONSENT_READ: Consent Read Scope gives the user read-only access
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false
x-onetrust:
  spec-label: OpenAPI 3.1.0