---
updatedAt: 2026-05-27T12:51:02.000Z
agentTools:
  projectIndex: https://developer.onetrust.com/onetrust/llms.txt
---

# Get List of Credentials

Use this API to retrieve a list of all credentials. The response will include details such as the credential name, ID, and reference key.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Data Use Governance - Data Discovery",
    "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"
            ]
          }
        ]
      }
    }
  },
  "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_Sort": {
        "type": "object",
        "properties": {
          "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"
          }
        }
      }
    },
    "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"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  }
}
```

# Sibling pages

* [Update Credential](https://developer.onetrust.com/onetrust/reference/updatecredential.md)
* [Create Credential](https://developer.onetrust.com/onetrust/reference/createcredential.md)
* [Get Credential](https://developer.onetrust.com/onetrust/reference/getcredentialbyid.md)
* [Delete Credential](https://developer.onetrust.com/onetrust/reference/deletecredential.md)