OneTrust Tags API

openapi: 3.2.0
info:
  title: Data Use Governance - Data Catalog Tags API
  description: The Data Catalog APIs provide comprehensive functionality for managing data governance assets within Data Catalog, enabling users to create, retrieve, and organize business glossaries, terms, and tags for effective data classification and metadata management.
  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: Tags
  description: APIs to manage tags for data classification, including creating new tags with various types and retrieving tag details with their associated terms.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json
  x-displayName: Tags
paths:
  /api/glossary/v1/tag-names:
    get:
      operationId: retrieveAllTagsName
      summary: Get List of Tags
      description: Use this API to retrieve a list of all tag names.
      tags:
      - Tags
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json
      parameters:
      - name: type
        in: query
        description: Type of the tag. For example, including the value for the type - Category, all the matching Tags will be retrieved.
        required: false
        schema:
          type: string
          enum:
          - CATEGORY
          - CLASSIFICATION
          - BUSINESS_DOMAIN
          - RETENTION
          - ROT
        example: CATEGORY
      responses:
        '200':
          description: "OK \nTag names retrieved successfully."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseListOfTags'
        '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:
      - DataUseGovernance-DataCatalog_OAUTH2:
        - DATA_CATALOG_READ
  /api/glossary/v1/tags/{name}/details:
    get:
      operationId: getTagDetailsWithAssociatedTerms
      summary: Get Tag
      description: Use this API to retrieve the details for the specified tag.
      tags:
      - Tags
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json
      parameters:
      - name: name
        in: path
        description: The name to get the details of the related tag. For example, including the value for the name Resume, matching tag details will be retrieved.
        required: true
        schema:
          type: string
        example: Resume
      responses:
        '200':
          description: "OK \nTag response retrieved successfully."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseOfTagTermResponse'
        '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:
      - DataUseGovernance-DataCatalog_OAUTH2:
        - DATA_CATALOG_READ
  /api/glossary/v2/tags:
    post:
      operationId: createTagV2
      summary: Create Tag
      description: 'Use this API to create a new tag in the Glossary.


        > 🗒 Things to Know

        >

        > - The `type` parameter is case-sensitive. For example, use CATEGORY instead of Category.'
      tags:
      - Tags
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-catalog.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataUseGovernance-DataCatalog_TagRequestV2'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustResponseOfTagResponse'
        '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:
      - DataUseGovernance-DataCatalog_OAUTH2:
        - DATA_CATALOG_WRITE
components:
  schemas:
    DataUseGovernance-DataCatalog_OneTrustPage:
      type: object
      properties:
        first:
          description: This parameter indicates whether the current page is the first page of the list.
          type: boolean
        last:
          description: This parameter indicates whether the current page is the last page of the list.
          type: boolean
        number:
          description: The page number of the results.
          type: integer
          format: int64
        size:
          description: The number of results per page.
          type: integer
          format: int64
        totalElements:
          description: The total number of results in the list.
          type: integer
          format: int64
        totalPages:
          description: The total number of pages in the list.
          type: integer
          format: int64
        sort:
          description: The sort criteria that dictates the order of the results.
          type: array
          items:
            $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustSort'
    DataUseGovernance-DataCatalog_OneTrustResponseOfTagTermResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_TagTermResponse'
        meta:
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata'
    DataUseGovernance-DataCatalog_OneTrustSort:
      type: object
      properties:
        direction:
          description: The order (ASC|DESC) by which results are sorted.
          type: string
          enum:
          - ASC
          - DESC
        property:
          description: The criteria by which results are sorted.
          type: string
    DataUseGovernance-DataCatalog_OneTrustResponseOfTagResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_TagResponse'
        meta:
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata'
    DataUseGovernance-DataCatalog_TagTermResponse:
      type: object
      properties:
        tagresponse:
          description: The tag response object containing tag details
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_TagResponse'
        termnames:
          type: array
          items:
            type: string
            description: Term name associated with the tag
            example: URL
    DataUseGovernance-DataCatalog_TagResponse:
      type: object
      properties:
        id:
          description: UUID of the tag
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174001
        tagId:
          description: Numeric identifier for the tag
          type: integer
          format: int64
          example: 45
        name:
          description: Name of the tag
          type: string
          example: Resume
        description:
          description: Description of the tag
          type: string
          example: This tag is used for any information related to Resume
        type:
          description: Type of the tag
          type: string
          example: CLASSIFICATION
        createdBy:
          description: UUID of the user who created the tag
          type: string
          format: uuid
          example: 897e4567-e89b-12d3-2345-426614174789
        createdDate:
          description: Tag creation timestamp
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
        updatedBy:
          description: UUID of the user who updated the tag
          type: string
          format: uuid
          example: 897e4567-e89b-12d3-2345-426614174789
        updatedDate:
          description: Tag update timestamp
          type: string
          format: date-time
          example: '2023-01-02T00:00:00Z'
        athenaId:
          description: Athena Id for the tag
          type: string
          format: uuid
          example: 754e4567-de34-12d3-a456-ddf414174777
    DataUseGovernance-DataCatalog_OneTrustResponseListOfTags:
      type: object
      properties:
        data:
          type: array
          items:
            type: string
            example: Biometric
        meta:
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustMetadata'
    DataUseGovernance-DataCatalog_OneTrustMetadata:
      type: object
      properties:
        page:
          description: The page number of the results.
          $ref: '#/components/schemas/DataUseGovernance-DataCatalog_OneTrustPage'
    DataUseGovernance-DataCatalog_TagRequestV2:
      type: object
      properties:
        name:
          description: Name of the tag
          type: string
          example: Financial
        type:
          description: Type of the tag
          type: string
          example: CATEGORY
          enum:
          - CATEGORY
          - CLASSIFICATION
          - BUSINESS_DOMAIN
          - RETENTION
          - ROT
        description:
          description: Short description about tag
          type: string
          example: This is the Financial information of customer
  securitySchemes:
    DataUseGovernance-DataCatalog_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            DATA_CATALOG_READ: Access to Data Catalog read operations for external systems
            DATA_CATALOG_WRITE: Access to Data Catalog write operations for external systems
    DataUseGovernance-DataAssetManagement_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            DATA_CATALOG_WRITE: Data Catalog Write Scope gives the user access to write operations
            DATA_CATALOG_READ: Data Catalog Read Scope gives the user access to read operations
    DataUseGovernance-DataCatalogMetadataExchange_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            DATA_CATALOG_READ: Access to Data Catalog read operations for external systems
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false
x-onetrust:
  spec-label: OpenAPI 3.1.0