OneTrust

OneTrust Credentials API

APIs to manage credential operations including creation, updates, deletion, retrieval, and secure reference key management for multiple system authentication types.

Documentation GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/discovery-scan-config/v2/credentials List data discovery credentials · Get List of Credentials #

Ask an LLM

“Which credentials are configured for data discovery scans?”

“Can I filter credentials by system name?”

Tell an agent

List all credentials.

Find credentials for system {systemName}.

PUT /api/discovery-scan-config/v2/credentials Update a credential · Update Credential #

Ask an LLM

“Can I change the reference key on an existing credential?”

“Is it possible to move a credential to another worker node?”

Tell an agent

Update credential {id} to reference key {referenceKey}.

Change credential {id}'s worker node to {workerNodeName}.

POST /api/discovery-scan-config/v2/credentials Create a credential · Create Credential #

Ask an LLM

“How do I add a credential for a scan of a new system?”

“What does a new credential need, like a reference key and worker node?”

Tell an agent

Create credential {name} for system {systemName} with reference key {referenceKey}.

Add a credential named {name} on worker node {workerNodeName}.

GET /api/discovery-scan-config/v2/credentials/{id} Get a credential · Get Credential #

Ask an LLM

“What system and reference key does a specific credential use?”

“Can I look up one credential by its ID?”

Tell an agent

Get credential {id}.

Show details of credential {id}.

DELETE /api/discovery-scan-config/v2/credentials/{id} Delete a credential · Delete Credential #

Ask an LLM

“Does deleting a credential remove its reference keys too?”

“Can I delete a credential I no longer scan with?”

Tell an agent destructive · confirm first

Delete credential {id}.

Remove credential {id} and its reference keys.

Documentation

https://developer.onetrust.com/onetrust/reference/attribute-management

https://developer.onetrust.com/onetrust/reference/activity-log

https://developer.onetrust.com/onetrust/reference/preferences-v2

https://developer.onetrust.com/onetrust/reference/banner

https://developer.onetrust.com/onetrust/reference/consent-receipts

https://developer.onetrust.com/onetrust/reference/applications

https://developer.onetrust.com/onetrust/reference/categorizations

https://developer.onetrust.com/onetrust/reference/domain-data

https://developer.onetrust.com/onetrust/reference/preferences

https://developer.onetrust.com/onetrust/reference/mobile-app-data

https://developer.onetrust.com/onetrust/reference/privacy-notice-v2

https://developer.onetrust.com/onetrust/reference/collection-points

https://developer.onetrust.com/onetrust/reference/catalog-search-v1

https://developer.onetrust.com/onetrust/reference/classification

https://developer.onetrust.com/onetrust/reference/custom-scan

https://developer.onetrust.com/onetrust/reference/carbon-management

https://developer.onetrust.com/onetrust/reference/audit-records

https://developer.onetrust.com/onetrust/reference/bulk-export

https://developer.onetrust.com/onetrust/reference/attachments

https://developer.onetrust.com/onetrust/reference/system-credentials

https://developer.onetrust.com/onetrust/reference/inventory-relationships-v2

https://developer.onetrust.com/onetrust/reference/model-management

https://developer.onetrust.com/onetrust/reference/tasks

https://developer.onetrust.com/onetrust/reference/groups-v2

https://developer.onetrust.com/onetrust/reference/assessment-actions

https://developer.onetrust.com/onetrust/reference/inventory

https://developer.onetrust.com/onetrust/reference/inventory-1

https://developer.onetrust.com/onetrust/reference/drop-management

https://developer.onetrust.com/onetrust/reference/incidents

https://developer.onetrust.com/onetrust/reference/document-controller

https://developer.onetrust.com/onetrust/reference/audits

https://developer.onetrust.com/onetrust/reference/initiatives

https://developer.onetrust.com/onetrust/reference/document-attachments

https://developer.onetrust.com/onetrust/reference/issues

https://developer.onetrust.com/onetrust/reference/control-implementations

https://developer.onetrust.com/onetrust/reference/training

https://developer.onetrust.com/onetrust/reference/contracts

Specifications

https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-credentials-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/onetrust:onetrust-credentials-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Data Use Governance - Data Discovery Credentials API
  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 Data Discovery API provides comprehensive REST endpoints for managing data discovery operations including data sources, scan profiles, credentials, and scan jobs with OAuth2 security and extensive filtering capabilities.
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: Credentials
  description: APIs to manage credential operations including creation, updates, deletion, retrieval, and secure reference key management for multiple system authentication types.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json
  x-displayName: Credentials
paths:
  /api/discovery-scan-config/v2/credentials:
    get:
      operationId: getCredentials
      summary: Get List of Credentials
      description: Use this API to retrieve a list of all credentials. The response will include details such as the credential name, ID, and reference key.
      tags:
      - Credentials
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json
      parameters:
      - name: name
        in: query
        description: The parameter to search for a credential by name.
        required: false
        schema:
          description: The parameter to search for a credential by name.
          type: string
          maxLength: 200
          minLength: 0
        example: AmazonS3 Ref Credential
      - name: systemName
        in: query
        description: The parameter to search for a credential by systemName.
        required: false
        schema:
          description: The parameter to search for a credential by systemName.
          type: string
          enum:
          - Azure Cosmos
          - Box
          - Cassandra
          - Azure Databricks
          - IBM DB2
          - Exchange
          - GCP
          - Google Workspace Gmail
          - Google BigQuery
          - Google BigTable
          - MongoDB
          - MySQL
          - OneDrive
          - Oracle RDBMS
          - PostgreSQL
          - Amazon S3
          - SalesForce
          - SAP HANA
          - ServiceNow
          - SharePoint
          - SMB
          - Snowflake
          - Microsoft SQL
          - Teradata
          - Workday
          - Zendesk
          - Amazon RDS for SQL Server
          - Azure SQL Server
          - Redshift
          - Google Drive
          - Amazon DynamoDB
          - Amazon Athena
          - SharePoint 2019 OnPrem
          - SFTP
          - NFS
          - GCS
          - Redis
          - Elastic Search
          - Microsoft Teams
          - Slack
          - AlibabaCloudOSS
          - Azure Files
          - Iceberg
          - Kafka
          maxLength: 50
          minLength: 0
        example: Amazon S3
      - name: page
        in: query
        description: Results page to be retrieved (0..N).
        schema:
          description: Results page to be retrieved (0..N).
          type: integer
          format: int32
          default: 0
          minimum: 0
        example: 1
      - name: size
        in: query
        description: Number of records per page (1..50). Maximum page size allowed is 50
        schema:
          description: Number of records per page (1..50). Maximum page size allowed is 50
          type: integer
          format: int32
          default: 20
          maximum: 50
          minimum: 1
        example: 20
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default is ascending.'
        schema:
          description: 'Sorting criteria in the format: property(,asc|desc). Default is ascending.'
          type: string
          default: createdDate,desc
          enum:
          - name,asc
          - name,desc
          - systemName,asc
          - systemName,desc
        example: name,desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataDiscovery_PageWrapperCredentialDto'
        '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-DataDiscovery_OAUTH2:
        - DATA_DISCOVERY
    put:
      operationId: updateCredential
      summary: Update Credential
      description: Use this API to update an existing credential.
      tags:
      - Credentials
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto'
      responses:
        '200':
          description: Credential updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto'
        '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-DataDiscovery_OAUTH2:
        - DATA_DISCOVERY
    post:
      operationId: createCredential
      summary: Create Credential
      description: Use this API to create a new credential.
      tags:
      - Credentials
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataUseGovernance-DataDiscovery_CredentialRequestV2Dto'
      responses:
        '201':
          description: Credential Created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto'
        '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-DataDiscovery_OAUTH2:
        - DATA_DISCOVERY
  /api/discovery-scan-config/v2/credentials/{id}:
    get:
      operationId: getCredentialById
      summary: Get Credential
      description: Use this API to retrieve a single credential by its unique identifier.
      tags:
      - Credentials
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json
      parameters:
      - name: id
        in: path
        description: ID of the credential. This value can be obtained from Get Credentials API.
        required: true
        schema:
          type: string
          format: uuid
        example: ad390cb4-9ce9-4976-8895-66d724493c7b
      responses:
        '200':
          description: Credential details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto'
        '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-DataDiscovery_OAUTH2:
        - DATA_DISCOVERY
    delete:
      operationId: deleteCredential
      summary: Delete Credential
      description: Use this API to delete an existing credential and its associated reference keys.
      tags:
      - Credentials
      x-onetrust:
        spec-label: https://developer.onetrust.com/onetrust/openapi/data-use-governance-data-discovery.json
      parameters:
      - name: id
        in: path
        description: ID of a credential. This value is obtained using [Create Credential]
        required: true
        schema:
          type: string
          format: uuid
        example: ad390cb4-9ce9-4976-8895-66d724493c7b
      responses:
        '204':
          description: Credential deleted successfully
        '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-DataDiscovery_OAUTH2:
        - DATA_DISCOVERY
components:
  schemas:
    DataUseGovernance-DataDiscovery_CredentialV2Dto:
      type: object
      properties:
        id:
          description: Unique ID for Credential
          type: string
          format: uuid
          example: 4f162d7c-a563-4bf1-a7c4-b7899f6dcdef
        name:
          description: Name of Credential
          type: string
          example: MySQL Credential
          maxLength: 200
          minLength: 0
        description:
          description: Credential Description
          type: string
          example: MySQL Ref Credential
          maxLength: 1024
          minLength: 0
        systemName:
          description: System Name
          type: string
          example: MySQL
          enum:
          - Azure Cosmos
          - Box
          - Cassandra
          - Azure Databricks
          - IBM DB2
          - Exchange
          - GCP
          - Google Workspace Gmail
          - Google BigQuery
          - Google BigTable
          - MongoDB
          - MySQL
          - OneDrive
          - Oracle RDBMS
          - PostgreSQL
          - Amazon S3
          - SalesForce
          - SAP HANA
          - ServiceNow
          - SharePoint
          - SMB
          - Snowflake
          - Microsoft SQL
          - Teradata
          - Workday
          - Zendesk
          - Amazon RDS for SQL Server
          - Azure SQL Server
          - Redshift
          - Google Drive
          - Amazon DynamoDB
          - Amazon Athena
          - SharePoint 2019 OnPrem
          - SFTP
          - NFS
          - GCS
          - Redis
          - Elastic Search
          - Microsoft Teams
          - Slack
          - AlibabaCloudOSS
          - Azure Files
          - Iceberg
          - Kafka
          maxLength: 50
          minLength: 0
        referenceKey:
          description: Reference Key
          type: string
          example: kv/mysql
          maxLength: 100
          minLength: 0
        workerNodeName:
          description: Worker Node Name
          type: string
          example: WN-24thAugust
          maxLength: 256
          minLength: 0
    DataUseGovernance-DataDiscovery_Pageable:
      type: object
      properties:
        page:
          type: integer
          format: int32
          minimum: 0
        size:
          type: integer
          format: int32
          minimum: 1
        sort:
          type: array
          items:
            type: string
    DataUseGovernance-DataDiscovery_PageWrapperCredentialDto:
      type: object
      properties:
        content:
          description: The content of this page.
          example:
          - id: 1
            name: Item
          items:
            $ref: '#/components/schemas/DataUseGovernance-DataDiscovery_CredentialV2Dto'
          type: array
        number:
          description: Current page number.
          type: integer
          format: int32
          example: 0
        size:
          description: The size of the page (number of elements per page).
          type: integer
          format: int32
          example: 20
        numberOfElements:
          description: The number of elements on the current page.
          type: integer
          format: int32
          example: 15
        totalElements:
          description: The total number of elements across all pages.
          type: integer
          format: int32
          example: 150
        totalPages:
          description: The total number of pages.
          type: integer
          format: int32
          example: 8
        first:
          description: Indicates if this is the first page.
          type: boolean
          example: true
        last:
          description: Indicates if this is the last page.
          type: boolean
          example: false
        empty:
          description: Indicates if the page is empty.
          type: boolean
          example: false
        sort:
          description: Sorting information for the page.
          $ref: '#/components/schemas/DataUseGovernance-DataDiscovery_Sort'
        pageable:
          description: Pagination information for the page.
          $ref: '#/components/schemas/DataUseGovernance-DataDiscovery_Pageable'
    DataUseGovernance-DataDiscovery_Sort:
      type: object
      properties:
        sort:
          type: array
          items:
            type: string
    DataUseGovernance-DataDiscovery_CredentialRequestV2Dto:
      type: object
      properties:
        name:
          description: Name of Credential
          type: string
          example: MySQL Credential
          maxLength: 200
          minLength: 0
        description:
          description: Credential Description
          type: string
          example: MySQL Ref Credential
          maxLength: 1024
          minLength: 0
        systemName:
          description: System Name
          type: string
          example: MySQL
          maxLength: 50
          minLength: 0
        referenceKey:
          description: Reference Key
          type: string
          example: kv/mysql
          maxLength: 100
          minLength: 0
        workerNodeName:
          description: Worker Node Name
          type: string
          example: WN-24thAugust
          maxLength: 256
          minLength: 0
  securitySchemes:
    DataUseGovernance-DataDiscovery_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            DATA_DISCOVERY: DATA_DISCOVERY scope for external systems
    DataUseGovernance-DataDiscoveryCustomClassiferMana_OAUTH2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://{hostname}/api/access/v1/oauth/token
          scopes:
            DATA_DISCOVERY: DATA_DISCOVERY scope for external systems
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false
x-onetrust:
  spec-label: OpenAPI 3.1.0