Support Open Console

Reports

Managing Conformity reports.

User Privileges

There are 4 possible Cloud Conformity roles. Each role grants different levels of access via the api. The roles are:

  • administrator
  • power user
  • read-only
  • custom

Users with custom role are managed manually by the administrator and can be given the following permissions:

  • full access to an account/s
  • read-only access to an account/s
  • no access to an account/s

User access to each endpoint is listed below:

Endpoint administrator power user read-only custom - full custom - read only custom - no access
GET /reports (get a list reports) Y Y Y Y Y N
GET /reports/reportId/entityId/type (downloads a report) Y Y Y Y Y N

List All Reports

get/reports

This end point allows you to query all reports that you have access to, based on the query parameters provided.

Administrator, power user, and read-only users have access to all reports. Includes account, group and organisation reports.

Users with custom role (full access / read only) only have access to account reports that they have been granted access to.

Users with custom role (no access) do not have access to any reports in the account/s that they have been denied access to.

Please note only up to one year's worth of reports will be returned.

Reports will be ordered based on the report's creation date.

If no parameters are provided, the end point will retrieve reports associated with the organisation, i.e. reports that have been generated for all accounts within your organisation.

If both accountId and groupId are present in the query string, only account reports will be returned.

Request
Security:
query Parameters
accountId
string

The Cloud Conformity ID of the account (optional)

groupId
string

Group Id (optional)

object or object

Configured Report Ids (optional)

Responses
200

OK

401

Unauthorized. The requesting user does not have enough privilege.

Response samples
application/json
{}

Download Report

get/reports/{reportId}/{entityId}/{type}

This end point allows you to download the report using a report-download-endpoint link.

Request
Security:
path Parameters
entityId
required
string

The entity Id, where entityId could be either an accountId, groupId or organisationId

reportId
required
string

ID of the report

type
required
string

The report type

Enum: "pdf" "csv" "xlsx"
Responses
200

OK

401

Unauthorized. The requesting user does not have enough privilege.

Response samples
application/json
{
  • "url": "string"
}