Download Users CSV

V1.0

Use this API to download users data in csv file format.

POST/adminui/user-management/v1/users/download

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. For example, offset: 0
sortFilter	username	String	Mandatory	Specify the username for this filter. For example, username: ASC
sortFilter
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 always parse responses using a 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=xxxxxxxxxxxxxxxxxxxxxxxxxx' \
--header 'Content-Type: application/json' \
--header 'Accept: application/csv' \
--header 'Authorization: Bearer <JWT_Token>' \
--data '

Request body

{
"limit": 5,
"offset": 0,
"sortFilter":
{ "username": "<username>" },
"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","<username>"
"USERNAME","First Name","Last Name","Email Address","MODULE","Roles","Tags","STATUS","External ID","Super User","SAML Status"
"<username1>","John","S","email","[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"
"<username2>","John","S","email1","[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"
"<username3>","S","Johndoe","<email>","[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","<email2>","[ITAM, QWEB_VM, ADMIN, ASSET_MANAGEMENT, CA]","[READER]","[Unassigned Business Unit]","ACTIVE","","false","false"
.......
.......
"<username4>","User","1","<email3>","[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","email","[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"
"<username5>","John","TestAccount1","<email4>","[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"

V2.0

The new version of this API is compliant to RESTful conventions. The legacy V1 endpoint remains the same.
Use this API to export the user list as a CSV file. The format and timezone query parameters are required; if either is omitted, the API returns a 400 Bad Request error. You can optionally pass a JSON request body to filter the set of users that is exported. This resource-oriented endpoint provides the same capability as the existing v1 download users CSV API.

POST/adminui/user-management/v2/users/export

Input ParametersInput Parameters

Parameter	Mandatory/ Optional	Data Type	Description
format	Optional	String	Specify the download format. The supported value is CSV.
timezone	Optional	String	Specify the timezone.

Sample - Export Users as CSVSample - Export Users as CSV

API Request

curl --location --request POST '<qualys_base_url>/adminui/user-management/v2/users/export?format=csv&timezone=Asia%2FKolkata' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data-raw '

API Body

{
  "limit": 5,
  "offset": 0,
  "sortFilter": {
    "username": "<username>"
  },
  "filter": {
    "role": "READER"
  }
}'

API Response

(Binary CSV file content is returned as the response body)

API Version	API Status	Release Date
/adminui/user-management/v1/user	To be deprecated	March 2027
/adminui/user-management/v2/users/export	Active	Oct 2026

Last updated: October, 2026