Platform Reports provide downloadable snapshots of authorization data across the PlainID Authorization Platform. Reports are generated through API calls and returned as secure PDF download links. This capability enables users to generate and download structured reports on platform objects.
Reports help organizations:
- Maintain structured governance processes
- Keep key personas aligned and informed
- Support operational governance
- Provide compliance and audit evidence
- Track the lifecycle of managed authorization objects across Environments
Access and Permissions
Report generation is available at the Environment level for users with the following roles:
- Environment Viewer
- Environment Admin
- Tenant Admin
Permissions are validated both when generating reports and when retrieving report download links.
Supported Report Types
Reports are generated as structured PDF documents designed for governance analysis, operational tracking, compliance reviews, and audit preparation.
Policies by Attribute
The policies_by_attribute report enables organizations to review how Policies are distributed across custom Attributes managed within the Environment.
Users can view:
- Policy classifications grouped by Attribute values
- Policy metadata and associated applications
- Classification coverage across Policies
- Policies that are missing classifications
- Governance and compliance alignment across managed Policies
Example: Policies by Regulatory Tags
Every Environment includes a default custom Attribute named Regulatory Tags.
Organizations can use this Attribute to classify Policies according to regulatory or compliance frameworks, such as:
- GDPR
- HIPAA
- PCI-DSS
- SOX
Using the policies_by_attribute report, users can generate a structured report showing which Regulatory Tags are associated with each Policy. This helps teams review compliance coverage, identify gaps, and support audit preparation activities.
Filtering Reports
The Create Report ID API call supports a filters object in the request body, so users can scope a report to a specific subset of Policies instead of reporting across the entire Environment. You can combine any of the following filters in a single request:
- applicationIds: Specifies the report to Policies associated with one or more specified Applications.
- state: Limits the report to Policies in a specific state, such as
Active. - completed: Limits the report to Policies marked as completed (
true) or not yet completed (false). - accessType: Limits the report to Policies with a specific access type, such as
AlloworDeny.
Users can combine multiple filters with multiple grouping Attributes in theattributesarray to produce a narrowly scoped, multi-dimensional report. For example, a request can group Policies by bothregulatoryTagsandPolicy-Workflow, while filtering to only completed, Active, Allow Policies within specific Applications.
Report Generation
Generating a report requires two API calls.
- Create a Report Request
A POST request creates a Report ID generation request.
When the request is submitted:
- The platform validates the request.
- A unique
reportIdis generated. - The report begins processing.
- Report metadata is returned.
Each request generates a new report ID.
- Retrieve the Report Download Link
A GET request uses the reportId to retrieve the latest report metadata and a valid PDF download link.
This flow supports asynchronous report generation. If the report is still processing, the status indicates that generation is still in progress.
Download URLs are time-limited. If a link expires, a new download URL can be generated using the same reportId.
To generate a report:
Step 1: Generate a Report ID
Use the Create Report ID to submit a report generation request.
The response returns a unique reportId used to track the report generation process.
Step 2: Generate a Download URL
Use the Get Report with the reportId to retrieve:
- The latest report generation status
- A secure PDF download URL for the generated report
Each API call generates a new secure download URL that remains valid for 24 hours.
Users can open the generated URL to download the report in PDF format.
If report generation is still in progress, the response returns the current processing status until the report becomes available.
Report Lifecycle
| Item | Retention |
|---|---|
| Report file | 30 days |
| Download URL validity | 24 hours |
After the download URL expires, a new URL can be retrieved using the report ID.