Privado
  • Privado
  • Getting Started With Privado
    • Quick Start
    • Running a Scan
    • Understanding Results
    • Command Reference
    • Understanding privado.json
      • Sources
      • Processing
      • Data Flow
      • Collections
      • Violations
  • Understanding Rules
    • What are Rules?
    • Sources
    • Sinks
      • Understanding Sinks
      • Storages
      • Third Parties
      • Leakages
      • Internal APIs
    • Collections
    • Policies
  • Tutorials
    • How to scan a repository using Privado
  • Customizing Privado
    • Add a new Source
    • Add a new Leakage Sink
    • Add a new Storage Sink
    • Add a new Third Party Sink
    • Add a new Policy
  • ROPA Report
    • Generating ROPA Report
  • Play Store Data Safety Report
    • Generate Play Store Data Safety Report
    • Uploading results to Play Store
  • Extra
    • Configurations
    • Contributing through GitHub
  • About Privado
    • LICENSING
    • Privacy Policy
    • Security
Powered by GitBook
On this page
Edit on GitHub
  1. Getting Started With Privado
  2. Understanding privado.json

Collections

Collections indicate all the API data collections that are present in the codebase.

A collection result consists of the following structure:

{
    "collections": [
        {
            "collectionId": "string",
            "name": "string",
            "isSensitive": "boolean",
            "collections": [
                {
                    "sourceId": "string",
                    "occurences": [
                        {
                            "endPoint": "string",
                            "sample": "string",
                            "lineNumber": "int",
                            "columnNumber": "int",
                            "fileName": "string",
                            "excerpt": "string"
                        }
                    ]
                }
            ]
        }
    ]
}

The parameters are explained below:

Field

Description

collectionId

ID of the collection which is detected

name

Name of the collection

isSensitive

Boolean indicating if the field is sensitive

collections

List of collections of the data element found in the code

sourceId

ID of the source which is collected

occurences

List of occurrences of the data element in the code

endPoint

Endpoint of the API

sample

name of the entity which is processed in API

lineNumber

Line number of the occurance

columnNumber

Column number of the occurance

fileName

Name of the file where the occurrence is detected

excerpt

A dump of the code around the occurrence

PreviousData FlowNextViolations

Last updated 2 years ago