ONonetrust
Credentials

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.

get/api/discovery-scan-config/v2/credentials

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/discovery-scan-config/v2/credentials
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: DATA_DISCOVERY

Query parameters

namestring

The parameter to search for a credential by name.

systemName'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'

The parameter to search for a credential by systemName.

pageinteger

Results page to be retrieved (0..N).

sizeinteger

Number of records per page (1..50). Maximum page size allowed is 50

sort'name,asc' | 'name,desc' | 'systemName,asc' | 'systemName,desc'

Sorting criteria in the format: property(,asc|desc). Default is ascending.

Response

OK

numberinteger

Current page number.

sizeinteger

The size of the page (number of elements per page).

numberOfElementsinteger

The number of elements on the current page.

totalElementsinteger

The total number of elements across all pages.

totalPagesinteger

The total number of pages.

firstboolean

Indicates if this is the first page.

lastboolean

Indicates if this is the last page.

emptyboolean

Indicates if the page is empty.

Example response

{
  "content": [
    {
      "id": 1,
      "name": "Item"
    }
  ],
  "size": 20,
  "numberOfElements": 15,
  "totalElements": 150,
  "totalPages": 8,
  "first": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.