Cloud 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.
For information about managing access to this API, see Accessing the Cloud Administration APIs.
Authentication
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.
Software Developer Kit
You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Rate 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 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
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, 403, 404, 429 |
| hardware_tokens | POST | POST/AdminInterface/restapi/v1/report /hardware_tokens/generate | application/json | empty payload | 201, 403, 404, 429 |
| mfa_clients | POST | POST/AdminInterface/restapi/v1/report /mfa_clients/generate | application/json | empty payload | 201, 403, 404, 429 |
Example 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, 429 |
Response Codes
The following table shows the response codes and descriptions for the API:
| Code | Description |
|---|---|
| 201 | Request was fulfilled successfully. |
| 403 | Not authorized to access this report. |
| 403 | MFA tracking is turned off. |
| 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. |
Download 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
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, 403, 404, 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, 403, 404, 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, 403, 404, 425,429 |
Example 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, 429 |
Response Codes
The following table shows response codes and descriptions for the API:
| Code | Description |
|---|---|
| 200 | Report downloaded successfully. |
| 403 | Not authorized to access this report. |
| 403 | MFA tracking is turned off. |
| 404 | Report not found. Report was not generated or does not exist. |
| 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. |
Generate and Download Report
Request this endpoint to generate and download the reports listed in this section. This API enables you to generate and download the reports every 8 hours.
Request Requirements
Use the following information to download each report:
| Report Type | Method | Request URL | Response Content Type | Response Body | Response Codes |
|---|---|---|---|---|---|
| admin_users | GET | GET/AdminInterface/restapi /v1/report/admin_users/generate-and-download | text/csv;charset=UTF-8 | UTF-8 encoded CSV file, downloaded as attachment | 200, 403, 404, 429 |
| radius_clients | GET | GET/AdminInterface/restapi /v1/report/radius_clients/generate-and-download | text/csv;charset=UTF-8 | UTF-8 encoded CSV file, downloaded as attachment | 200, 403, 404, 429 |
Example Request/Response
The following table lists the response details:
| Method | Request URL | Response Body | Response Codes |
|---|---|---|---|
| GET | GET/AdminInterface/restapi/v1/report/admin_users/generate-and-download | admin_users_report.csv | 200, 429 |
| GET | GET/AdminInterface/restapi/v1/report/radius_clients/generate-and-download | radius_clients_report.csv | 200, 429 |
Response Codes
The following table shows response codes and descriptions for the API:
| Code | Description |
|---|---|
| 200 | Report generated and downloaded successfully. |
| 400 | Report does not exist. |
| 403 | Not authorized to access this report. |
| 429 | Too many requests sent in a short period of time. Report was already generated and downloaded less than 8 hours ago. |
Related Articles
Change the display pictures of the software token profiles on RSA Authentication Manager 8.x Security and Self-Service con… Number of Views In the General Settings associations page clicking reset creates System Internal Error Number of Views Zimbra integration with RSA Via Access Number of Views Manage OAuth API Clients Number of Views Cloud Administration Event Log API Number of Views
Trending Articles
RSA MFA Agent 2.3.6 for Microsoft Windows Installation and Administration Guide RSA Authentication Manager 8.9 Release Notes (January 2026) How to install the jTDS JDBC driver on WildFly for use with Data Collections in RSA Identity Governance & Lifecycle RSA Authentication Manager 8.8 Setup and Configuration Guide Artifacts to gather in RSA Identity Governance & Lifecycle
