Download Users CSV
Use this API to download users data in csv file format.
Input ParametersInput Parameters
| Parameter | Sub Parameters | Data Type | Mandatory/Optional | Description |
|---|---|---|---|---|
| format | - | String | Mandatory | Specify format of the file to be downloaded. The default format is CSV. |
| timezone | - | String | Mandatory | Specify the timezone. For example: Asia/Kolkata |
| limit | -- | Number | Mandatory | Specify the limit that defines the maximum number of results in a single response. THis limit controls the pagination size. For example, limit: 50 |
| offset | - | Number | Mandatory |
Specify the offset value. This is the number of records to skip before beginning to return results and is used for pagination. |
| sortFilter | username | String | Mandatory |
Specify the username for this filter. |
| filter | role | String | Mandatory | Specify the role for this filter. For example, role: READER, SCANNER |
The API request and response are in JSON format. Some characters, such as backslash (\) and double quotes (") in passwords or other fields may appear escaped in raw JSON responses. It is recommended to alway as parse responses using standard JSON parser to retrieve the correct values.
Sample - Download Users CSVSample - Download Users CSV
API request
curl --location '<qualys_base_url>/adminui/user-management/v1/users/download?format=CSV&timezone=Asia%2FKolkata' \
--header 'Cookie: QualysSession=37486ebbba8f832af55d6ea4bbaf2636' \
--header 'Content-Type: application/json' \
--header 'Accept: application/csv' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '
Request body
{
"limit": 5,
"offset": 0,
"sortFilter":
{ "username": "ASC" },
"filter":
{ "role": "READER" }
}Response (This response is truncated)
"Note: User download is having limit of 1000 records. Try Using pagination API."
"User Data","2025-02-25T12:23:24.062+05:30","87"
"Acme","California","USA","205656"
"John Doe","quays_wy40"
"USERNAME","First Name","Last Name","Email Address","MODULE","Roles","Tags","STATUS","External ID","Super User","SAML Status"
"quays_wa93","John","S","johndoe@acme.com","[QWEB_PC, ITAM, QWEB_VM, ADMIN, ASSET_MANAGEMENT, CA, UD]","[Unified Dashboard User, PC User, Reporting Manager, Unified Dashboard User, READER, Reporting Manager, Reporting Manager, Reporting Reader, Reporting Reader, VM User, Reporting Reader]","[Unassigned Business Unit]","PENDING_ACTIVATION","-","false","false"
"quays_wy96","John","S","johndoe@acme.com","[QWEB_PC, ITAM, QWEB_VM, ADMIN, ASSET_MANAGEMENT, PM, CA, UD]","[Unified Dashboard User, CSAM Job User, PC User, Reporting Manager, READER, Reporting Manager, Reporting Reader, VM User, Unified Dashboard User, CSAM Job Manager, Reporting Manager, Reporting Reader, Reporting Reader]","[Unassigned Business Unit]","ACTIVE","","false","false"
"quays_wy97","S","Johndoe","JohnJohndoe@acme.com","[QWEB_PC, ITAM, QWEB_VM, ADMIN, ASSET_MANAGEMENT, PM, CA, TC]","[PC User, PATCH USER, READER, VM User, PC/SCA User]","[Unassigned Business Unit]","PENDING_ACTIVATION","-","false","false"
"quays_xr6","John","0706 reader","johndoe@acme.com","[ITAM, QWEB_VM, ADMIN, ASSET_MANAGEMENT, CA]","[READER]","[Unassigned Business Unit]","ACTIVE","","false","false"
.......
.......
"quaysxuc","User","1","danielm@acme.com","[QWEB_PC, ITAM, QWEB_VM, ADMIN, ASSET_MANAGEMENT, CA, UD]","[PC User, Unified Dashboard User, READER, Reporting Reader]","[Unassigned Business Unit]","PENDING_ACTIVATION","","false","false"
"quaysxut4","John","TestAccount","johndoe@acme.com","[QWEB_PC, ITAM, QWEB_VM, ADMIN, ASSET_MANAGEMENT, CA, UD]","[Unified Dashboard User, PC User, Reporting Manager, Unified Dashboard User, READER, Reporting Manager, Reporting Manager, Reporting Reader, Reporting Reader, VM User, Reporting Reader]","[Unassigned Business Unit]","PENDING_ACTIVATION","1234567","false","false"
"quaysxut5","John","TestAccount1","johndoe@acme.com","[QWEB_PC, ITAM, QWEB_VM, ADMIN, ASSET_MANAGEMENT, CA, UD]","[Unified Dashboard User, PC User, Reporting Manager, Unified Dashboard User, READER, Reporting Manager, Reporting Manager, Reporting Reader, Reporting Reader, VM User, Reporting Reader]","[Unassigned Business Unit]","PENDING_ACTIVATION","1234567","false","false"