Skip to content

Database Browser Report

Report generation

Proper setup of database browser is required. Read more

Warning: Audit reports are being updated to better reflect browser's look and behavior. In this version they can only be issued for PostgreSQL, but are missing filter handling, security tags and checksums.

To generate the report, go to Database Browser in Heimdall GUI. By clicking the Report button at the bottom of this section, you can generate and download a report of the data source structure. This process will take a while, which depends on the database type and its size. The Heimdall dev team works on this feature.

This report output is a JSON file reflecting the structure presented by database browser. It includes all users and roles configured on the database, with their access to all objects, down to the column level. The report can be considered a form of access discovery, specific for the database, and helps to normalize audits of different database types. The call to generate this report can be triggered with an automated API call, so it can tie in with a periodic auditing system that spots changes to the privileges for a compliance team.

Supported database types

The supported database is PostgreSQL.

File name

The output file is named using the following default format:

{dataSourceName}_report_{yyyyMMddHHmm}.json

Where:

  • dataSourceName the Data Source for which the report is generated
  • yyyyMMddHHmm represents the timestamp of when the generation process starts

Report Format

Report output is a JSON file with 5 levels of depth:

  1. database
  2. identity
  3. schema
  4. object
  5. column

Each database element uses its name as the key of its corresponding section.

Database

The database section contains identities.

Identity

Users and roles are otherwise referred to as identities.

Each identity has: * IdentityMemberships - where other identities granted to them are listed, directly or by being inherited from another * Global privileges - privileges that the identity has on the database * Schemas

Schema

Each schema has privileges (for a given identity) and has sections for each object type depending on database type.

Objects

Objects listed are dependent on database type. In case of PostgreSQL those are: table, foreign table, view, materialized view, routines, sequences, types and domains.

Types other than tables and views do not have any fields yet.

Tables and Views have privileges for a given identity. Views also have a list of other objects used to gather data for the view.

Column

The column section contains dataType and privileges for a given identity.