List Users
Use this API to find the list of users.
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 - Get a List of UsersSample - Get a List of Users
API Request
curl --location --request POST '<qualys_base_url>/adminui/user-management/v1/users' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>
--data '
Request Body
{
"limit": 100,
"offset": 0,
"sortFilter": {
"username": "ASC"
}
}To filter data, the API request must include the following filters: username (string), firstName (string), lastName (string), status (string), emailAddress (string), role (string), lastLoginDate (DD-MMM-YY), updatedDate (DD-MMM-YY), business_units (string), and saml (string).
API Response
{
"totalCount": 2,
"users": [
{
"updatedDate": 1729142368,
"lastLoginDate": 1702132125,
"id": 563028138,
"uuid": "7xxxxxaf-6xx0-db26-8xxa-daxxxxxxca8f",
"customerId": 1097221,
"username": "quaxx_xx83",
"firstName": "Axxxxxxt",
"language": "EN",
"lastName": "Kxxxsaxxxx",
"emailAddress": "sxxxxxva@qxxxxs.com",
"title": "Unit Manager1",
"userTimezone": "BROWSER",
"gmtShift": 0,
"status": "ACTIVE",
"isSuperuser": false,
"systemUser": false,
"accessAllAssets": true,
"filterQagentAssets": false,
"qwebUserRole": "UNIT MANAGER",
"phone": "0xx580xx5xx",
"inScope": false,
"assetType": "USER",
"transferPersonalInfo": false,
"transferAssetGroups": false,
"roles": [
{
"id": 3727138,
"name": "CA MANAGER",
"description": "Cloud Agent Manager User",
"createdBy": {},
"updatedBy": {}
}
],
"modules": [
"QWEB_VM",
"CA",
"UD"
],
"tags": [
{
"tagId": 29598475,
"id": "cxxxa8xx-8xxf-4axx-bdxx-c6xx637bbxxx",
"name": "ftfy",
"display": {},
"inScope": true,
"favorite": false
},
{
"tagId": 24222929,
"id": "axxx6e79-xxxx-4b93-xxb7-5xxx1251xx1e",
"name": "SxxxxxxK_Ixxx_BU",
"reservedType": "BUSINESS_UNIT",
"display": {},
"inScope": true,
"favorite": false,
"srcBusinessUnitId": 1507580
}
]
},
...
{
"updatedDate": 1724827555,
"id": 997626749,
"uuid": "cxxxa0bd-xxxx-5xxd-xxxx-xxx81cf8xxx8",
"customerId": 1097221,
"username": "qxxxxx_daxxx",
"firstName": "abc",
"language": "EN",
"lastName": "abc",
"emailAddress": "sxxxxxx@qxxxys.com",
"title": "abc",
"gmtShift": 0,
"status": "PENDING_ACTIVATION",
"isSuperuser": false,
"systemUser": false,
"accessAllAssets": false,
"filterQagentAssets": false,
"qwebUserRole": "READER",
"phone": "123",
"fax": "123",
"inScope": false,
"assetType": "USER",
"transferPersonalInfo": false,
"transferAssetGroups": false,
"roles": [
{
"id": 5338845,
"name": "Unified Dashboard User",
"description": "Unified Dashboard User",
"createdBy": {},
"updatedBy": {}
},
{
"id": 3726931,
"name": "PC User",
"description": "PC User",
"createdBy": {},
"updatedBy": {}
},
{
"id": 4080757,
"name": "Reporting Reader",
"description": "Reporting Reader",
"createdBy": {},
"updatedBy": {}
},
{
"id": 3726930,
"name": "VM User",
"description": "VM User",
"createdBy": {},
"updatedBy": {
"id": 23028404,
"username": "qxxxx_xx80",
"firstname": "xxxxxam"
}
},
{
"id": 8924786,
"name": "test123",
"createdBy": {
"id": 23028404,
"username": "qxxxx_xx80",
"firstname": "xxxxxam"
},
"updatedBy": {
"id": 23028404,
"username": "qxxxx_xx80",
"firstname": "xxxxxam"
}
},
{
"id": 3726925,
"name": "READER",
"description": "Read-Only User",
"createdBy": {},
"updatedBy": {
"id": 23028404,
"username": "qxxxx_xx80",
"firstname": "xxxxxam"
}
}
],
"modules": [
"QWEB_PC",
"QWEB_VM",
"CA",
"UD",
"THREAT_PROTECT",
"ETM"
],
"tags": [
{
"tagId": 16884413,
"id": "fxxx6axx-e728-xx7b-axx7-dxxx4xxxxf11",
"name": "Test_UM",
"reservedType": "BUSINESS_UNIT",
"display": {
"backgroundColor": -16711936
},
"inScope": true,
"favorite": false,
"srcBusinessUnitId": 628535
}
]
}