Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The reports resource provides access various operations that aid in managing the health check reports for an organization. The Query operation returns all health check reports for an organization, and provides the report IDs used to identify which repots should be exported or deleted. The Export operation bundles specified health check reports into a .zip file that administrators can download to access CSV and JSON versions of the reports. The Delete operation permanently deletes specified reports from an organization.
Request parameters
| Parameter | Details |
|---|---|
| The response format. The only supported format is |
Example usage
The following is a sample request URL used to access the reports resource:
https://organization.example.com/<context>/admin/healthCheck/reports