LightBeam Documentation
Installer GuidesData SourcesPlaybooksInsightsPrivacyOpsGovernance
  • 💡What is LightBeam?
  • 🚀Getting Started
    • ⚙️Installer Guides
      • Pre-Requisites / Security Configurations
        • Firewall Requirements
        • Securing LightBeam on EKS with AWS Certificate Manager on Elastic Load Balancer
        • Configure HTTPS for LightBeam Endpoint FQDN Standalone deployment
        • Using Custom Certificates with LightBeam
        • Securing LightBeam on GKE with Google Certificate Manager and GCE Ingress
      • Core
        • LightBeam Deployment Instructions
        • LightBeam Installer
        • Web App Deployment
        • LightBeam Diagnostics
        • LightBeam Cluster Backup & Restore using Velero
      • Platform Specific
        • AWS
        • Microsoft Azure
        • Google Cloud (GKE)
        • Standalone Virtual Machine
        • Deployment on an Existing Managed Kubernetes Cluster
        • Azure Marketplace Deployment
      • Integration and Setup
        • Setting Up AWS PrivateLink for RDS-EKS Interaction
        • Twingate and LightBeam Integration Guide
        • Data Subject Request Web Application Server
        • Generate CSR for LightBeam
  • 🧠Core Features
    • 🔦Spectra AI
      • 🔗Data Sources
        • Cloud Platforms
          • AWS Auto Discovery
          • GCP Auto Discovery
        • Databases and Datalakes
          • PostgreSQL
          • Aurora (PostgreSQL)
          • Snowflake
          • MS SQL
          • MySQL
          • Aurora (MySQL)
          • BigQuery
          • AWS Redshift
          • Oracle
          • DynamoDB
          • MongoDB
          • CosmosDB (PostgreSQL)
          • CosmosDB (MongoDB)
          • CosmosDB (NoSQL)
          • Looker
          • AWS Glue
          • Databricks
          • SAP HANA
          • CSV Files as a Datasource
        • Messaging
          • Gmail
          • Slack
          • MS Teams
          • MS Outlook
        • Developer Tools
          • Zendesk
          • ServiceNow
          • Jira
          • GitHub
          • Confluence
        • File Repositories
          • NetDocuments
          • AWS S3
          • Azure Blob
          • Google Drive
          • OneDrive
          • SharePoint
          • Viva Engage
          • Dropbox
          • Box
          • SMB
        • CRM
          • Hubspot
          • Salesforce
          • Automated Data Processing (ADP)
          • Marketo
          • Iterable
          • MS Dynamics 365 Sales
          • Salesforce Marketing Cloud
      • 🔔PlayBooks
        • What is LightBeam Playbooks?
        • Policy and Alerts
          • Types of Policies
          • How to create a rule set
            • File Extension Filter
          • Configuring Retention Policies
          • Viewing Alerts
          • Sub Alerts
            • Reassigning Sub-Alerts
            • Sub-alert States
          • Levels of Actions on Alerts
          • User Roles and Permissions
            • Admin View
            • Alert Owner View
            • Onboarding New Users
              • User Management
              • Okta Integration
              • Alert Assignment Settings
              • Email Notifications
            • Planned Enhancements
          • Audit Logs
          • No Scan List
          • Permit List
          • Policy in read-only mode
      • 📊Insights
        • Entity Workflow
        • Document Classification
        • Attribute Management Overview
          • Attributes Page View
          • Attribute Sets
          • Creating Custom Attribute
          • Attributes List
        • Template Builder
        • Label Management
          • MIP Integration
          • Google Labels Integration
      • 🗃️Reporting
        • Delta Reporting
        • Executive Report
        • LightBeam Lens
      • Scanning and Redaction of Files
        • On-demand scanning
      • How-to Guides
        • Leveraging LightBeam insights for structured data sources
      • LightBeam Dashboard Outlay
      • Risk Score
    • 🏛️PrivacyOps
      • Data Subject Request (DSR)
        • What is DSR?
        • Accessing the DSR Module
        • DSR Form Builder (DPO View)
          • Creating a New DSR Form
            • Using a Predefined Template
            • Creating a Custom Form
          • Form Configuration
          • Form Preview and Publishing
          • Multi-Form Management
          • Messaging Templates
        • Form Submission & Email Verification (Data Subject View)
        • DSR Management Dashboard (DPO View)
        • Processing DSR Requests
          • Data Protection Officer (DPO) Workflow
          • Self Service Workflow (Direct Validation)
          • Data Source Owner (DSO) Workflow
        • DSR Report
      • 🚧Consent Management
        • Overview
        • Consent Logs
        • Preference Centre
        • Settings
      • 🍪Cookie Consent
        • Dashboard
        • Banners
        • Domains
        • Settings
        • CMP Deployment Guide for Google Tag Manager
        • FAQs
      • 🔏Privacy Impact Assessment (PIA)
        • PIA Templates
        • PIA Assessment Workflow
        • Collaborator View
        • Process Owner Login View (With Collaborator)
        • Filling questionnaire without collaborator
        • Submitting the assessment for DPO review
        • DPO review process
        • Marking the assessment as reviewed
        • Editing and resubmitting assessments after DPO review
        • Revoke review request
        • Edit Reviewer
        • PIA Reports
      • ⏺️Records of Processing Activity (RoPA)
        • Creating a RoPA Template
          • How to clone a template
          • How to use a template
        • How to create a process
          • Adding Process Details
          • Adding Data Elements
          • Adding Data Subjects
          • Adding Data Retention
          • Adding Safeguards
          • Adding Transfers
          • Adding a Custom Section
          • Setting a Review Schedule
          • Data Flow Diagram
        • How to add a collaborator
        • Overview Section
        • Generating a RoPA Report Using LightBeam
        • Collaborator working on a ticket
    • 🛡️Governance
      • Access
        • Dashboard
        • Users
        • Groups
        • Objects
        • Active Directory Settings
        • Access Governance at a Data Source Level
        • Policies and Alerting
        • Access Governance Statistics
        • Governance Module Dashboard
      • Privacy At Partners
  • 📊Tools & Resources
    • 🔀API Documentation
      • API to Create Reports for Structured Datasource
    • ❓Onboarding Assessments
      • Structured Datasource Onboarding Questionnaire
        • MongoDB/CosmosDB Questionnaire
        • Oracle Datasource Questionnaire
      • SMB Questionnaire
    • 🛠️Administration
      • Audit Logs
      • SMTP
        • Basic and oAuth Configuration
      • User Management
        • SAML Identity Providers
          • Okta
            • LightBeam Okta SAML Configuration Guide
          • Azure
            • Azure AD SAML Configuration for LightBeam
          • Google
            • Google IDP
        • Local User Management
          • Adding a User to the LightBeam Dashboard
          • Reset Default Admin Password
  • 📚Support & Reference
    • 📅Release Notes
      • LightBeam v2.2.0
      • Reporting Release Notes
      • Q1 2024 Key Enhancements
      • Q2 2024 Key Enhancements
      • Q3 2024 Key Enhancements
      • Q4 2024 Key Enhancements
    • 📖Glossary
Powered by GitBook
On this page
  • 1. Authentication
  • Request URL
  • Headers
  • Body (each key value in 'x-www-form-urlencoded' form)
  • 2. Get Datasource ID
  • Request URL
  • Headers
  • 3. Create new reports
  • Request URL
  • Headers
  • Request
  • Sample Request Body
  • Sample Response Body
  • Response Codes
  • Postman Collection
  • About LightBeam
  1. Tools & Resources
  2. API Documentation

API to Create Reports for Structured Datasource


1. Authentication

Obtain 'x-access-token'

Authenticate with the system to obtain an x-access-token. This token must be included in all client requests for server validation.

It can be obtained from this end-point.

Request URL

Method
URL

POST

auth/realms/master/protocol/openid-connect/token

Headers

Key
Values

Content-Type

application/x-www-form-urlencoded

Body (each key value in 'x-www-form-urlencoded' form)

Key
Values

grant_type

password

client_id

admin-cli

username

<username>

password

<password>


2. Get Datasource ID

Request URL

Method
URL

GET

api/datasources

Headers

Key
Values

x-access-token

string

This will fetch a list of all available data sources in the system. Copy the ID of the datasource for which the report is to be fetched.

3. Create new reports

Request URL

Method
URL

POST

/api/reports

Headers

Key
Values

x-access-token

string

Request

Key
Values

reportFormat

enum [CSV, JSON]

CSV -> Generate Report in CSV format

JSON -> Generate Report in JSON format

reportType

enum [TABLE_LIST, FILE_LIST, ENTITY-LIST, DSR_REQUEST_LIST]

TABLE_LIST -> For structured datasource, TABLE_LIST option is to be used to generate table view reports.

FILE LIST -> To generate file view report.

ENTITY-LIST -> To generate entity view reports.

DSR_REQUEST_LIST -> To generate a DSR ticket report.

parameters

list[objects]

[{

“key”: <string>,

“value”: <string>

},...]

Individual objects (Parameters -> objects) are defined below.

Parameters -> objects

key

enum [DATASOURCE_ID, CURSOR]

DATASOURCE_ID -> ID of the structured data source whose report needs to be generated.

CURSOR -> This is internal field used to pagination, since only full report generation is supported you need to pass this as empty (i.e “”)

values

string

Sample Request Body

{
  "reportFormat": "CSV",
  "reportType": "TABLE_LIST",
  "parameters": [
    {
      "key": "DATASOURCE_ID",
      "values": "640594b9b09f97ee2e49adeb"
    },
    {
      "key": "CURSOR",
      "values": ""
    }
  ]
}

Sample Response Body

[
   {
       "datasourceName": "mysql-demo",
       "databaseName": "automation_stuff",
       "instanceName": "<sample_id>",
       "tableName": "parent_table",
       "schemaName": "dbo",
       "columnName": "first_name",
       "attributeName": "FIRST_NAME",
       "attributeInstanceCount": 23,
       "attributeSensitivityLabel": "medium"
   },
      {
       "datasourceName": "mysql-demo",
       "databaseName": "automation_stuff",
       "instanceName": "<sample_id>",
       "tableName": "parent_table",
       "schemaName": "dbo",
       "columnName": "drivers_license_number",
       "attributeName": "US_DRIVER_LICENSE",
       "attributeInstanceCount": 11,
       "attributeSensitivityLabel": "high"
   }
]

Response Codes

Status
Response
Description

200

File will be downloaded.

Indicates a successful operation.

422

{"error":"Validation error."}

A validation error occurred.

401

{"error":"Unauthorized."}

The user is not authorized.

500

{"error":"Something went wrong. Please try again later."}

A server-side error occurred.


Postman Collection


About LightBeam

LightBeam automates Privacy, Security, and AI Governance, so businesses can accelerate their growth in new markets. Leveraging generative AI, LightBeam has rapidly gained customers’ trust by pioneering a unique privacy-centric and automation-first approach to security. Unlike siloed solutions, LightBeam ties together sensitive data cataloging, control, and compliance across structured and unstructured data applications providing 360-visibility, redaction, self-service DSRs, and automated ROPA reporting ensuring ultimate protection against ransomware and accidental exposures while meeting data privacy obligations efficiently. LightBeam is on a mission to create a secure privacy-first world helping customers automate compliance against a patchwork of existing and emerging regulations.

PreviousAPI DocumentationNextOnboarding Assessments

Last updated 1 year ago

For any questions or suggestions, please get in touch with us at: .

📊
🔀
support@lightbeam.ai
3KB
Lightbeam APIs.postman_collection.json
Postman collection for Lightbeam APIs
744B
Lightbeam APIs.postman_environment.json
Postman Environment for Lightbeam APIs