Cloud Administration Generate and Download Report APIsCloud Administration Generate and Download Report APIs
These APIs enable Helpdesk Administrators or Super Administrators to generate and download the available reports in the Cloud Administration Console.
AuthenticationAuthentication
Clients calling these APIs must authenticate themselves by including a JSON Web Token in a request. For instructions on using this token, see Authentication for the Cloud Administration REST APIs.
Administrative RolesAdministrative Roles
These APIs can use an API Key that is associated with either the Super Administrator or Help Desk Administrator role. For more information, see Manage the Cloud Administration REST API Keys.
Software Developer KitSoftware Developer Kit
You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Rate LimitingRate Limiting
Rate limiting is applied to these APIs to manage their usage and to restrict the request rate. Using these APIs, you can generate the reports only every 8 hours, and they can be downloaded only once every 15 minutes per tenant. If you breach any of these conditions, you will receive an HTTP status code of 429.
These APIs are composed of the following endpoints:
Generate ReportGenerate Report
Request this endpoint to generate a report in the Cloud Administration Console. The report on this API is equivalent to the report that you can download from the Cloud Administration interface.
Request Requirements Request Requirements
Use the following information to generate each report:
Report Type | Method | Request URL | Response Content Type | Response Body | Response Codes |
---|---|---|---|---|---|
users | POST |
POST/AdminInterface/restapi/v1/report /users/generate |
application/json | empty payload | 201, 404, 429, 403 |
hardware_tokens | POST |
POST/AdminInterface/restapi/v1/report /hardware_tokens/generate |
application/json | empty payload | 201, 404, 429, 403 |
mfa_clients | POST |
POST/AdminInterface/restapi/v1/report /mfa_clients/generate |
application/json | empty payload | 201, 404, 429, 403 |
Example Request / ResponseExample Request / Response
The following table shows the response details:
Method | Request URL | Request Body | Response Body | Response Codes |
---|---|---|---|---|
POST |
POST/AdminInterface/restapi/v1/report/users/generate
|
empty payload | empty payload | 201 |
Response CodesResponse Codes
The following table shows the response codes and descriptions for the API:
Code | Description |
---|---|
201 | Request was fulfilled successfully. |
404 | Report not found. Not supported by API yet. |
429 | Too many requests sent in a short period of time. Only one report can be generated every 8 hours. |
403 | Not authorized to access this report. |
403 | MFA tracking is turned off |
Download ReportDownload Report
Request this endpoint to download a report in the Cloud Administration Console. This API enables you to download the reports every 15 minutes.
Request Requirements Request Requirements
Use the following information to download each report:
Report Type | Method | Request URL | Response Content Type | Response Body | Response Codes |
---|---|---|---|---|---|
users | GET |
GET/AdminInterface/restapi |
application/octet-stream | MediaType.APPLICATION_OCTET_STREAM_VALUE ("application/octet-stream") | 200, 404, 403, 425,429 |
hardware_tokens | GET | GET/AdminInterface/restapi /v1/report/hardware_tokens/download |
application/octet-stream | MediaType.APPLICATION_OCTET_STREAM_VALUE ("application/octet-stream") | 200, 404, 403, 425,429 |
mfa_clients | GET |
GET/AdminInterface/restapi /v1/report/mfa_clients/download |
application/octet-stream | MediaType.APPLICATION_OCTET_STREAM_VALUE ("application/octet-stream") | 200, 404, 403, 425,429 |
Example Request / ResponseExample Request / Response
The following table lists the response details:
Method | Request URL | Response Body | Response Codes |
---|---|---|---|
GET |
GET/AdminInterface/restapi/v1/report/users/download |
all_users_report.csv in an octet-stream | 200, 425 |
Response CodesResponse Codes
The following table shows response codes and descriptions for the API:
Code | Description |
---|---|
200 | Report downloaded successfully. |
404 | Report not found. Report was not generated or does not exist. |
403 | Not authorized to access this report. |
403 | MFA tracking is turned off. |
425 | Report not generated yet. |
429 | Too many requests sent in a short period of time. Report was already downloaded less than 15 minutes ago. |