Using this API, you can fetch user data using id, username, and roleName. Super User or Manager role can use this API to get user details. You cannot retrieve data for other Super Users or Managers. The roleName in the Search API implies the roles assigned to the user. To get assigned role details for a particular user, you can use the Get or Search API.
- Search API includes the role and tag data in the response, which is assigned to the user. To get the list of tags that can be used in the Admin API calls, use Asset Management (AM) API /qps/rest/2.0/search/am/tag/
- This API response fetches the user list only for users in Active status.
This API uses https://qualysapi.qualys.com URL in the endpoint and uses basic authentication. Refer here to locate your platform URL.
API request
curl -n -u "USERNAME:PASSWORD"
"qualys_base_url/qps/rest/2.0/search/am/user/"
Request body
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
<filters>
<Criteria field="id" operator="EQUALS">193597948</Criteria>
</filters>
<preferences>
<limitResults>500</limitResults>
</preferences>
</ServiceRequest>
Response
<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="qualys_base_url/qps/xsd/2.0/am/user.xsd">
<responseCode>SUCCESS</responseCode>
<count>10</count>
<hasMoreRecords>false</hasMoreRecords>
<data>
<User>
<id>19359794</id>
<username>quays_ru13</username>
<firstName>Reader</firstName>
<lastName>User</lastName>
<emailAddress>[email protected]</emailAddress>
<title>test</title>
<scopeTags>
<list>
<TagData>
<id>10449936</id>
<name>test_agent</name>
</TagData>
</list>
</scopeTags>
..
<roleList>
<list>
<RoleData>
<id>2712768</id>
<name>VM User</name>
</RoleData>
..
</list>
</roleList>
</User>
</data>
</ServiceResponse>
API request
curl -n -u "USERNAME:PASSWORD"
"qualys_base_url/qps/rest/2.0/search/am/user/"
Request body
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
<filters>
<Criteria field="username" operator="EQUALS">quays_ru13</Criteria>
</filters>
<preferences>
<limitResults>500</limitResults>
</preferences>
</ServiceRequest>
Response
<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="qualys_base_url/qps/xsd/2.0/am/user.xsd">
<responseCode>SUCCESS</responseCode>
<count>10</count>
<hasMoreRecords>false</hasMoreRecords>
<data>
<User>
<id>193597948</id>
<username>quays_ru13</username>
<firstName>Reader</firstName>
<lastName>User</lastName>
<emailAddress>[email protected]</emailAddress>
<title>test</title>
<scopeTags>
<list>
<TagData>
<id>10449936</id>
<name>test_agent</name>
</TagData>
..
</list>
</scopeTags>
<roleList>
<list>
<RoleData>
<id>2712768</id>
<name>VM User</name>
</RoleData>
..
</list>
</roleList>
</User>
</data>
</ServiceResponse>
API request
curl -n -u "USERNAME:PASSWORD"
"qualys_base_url/qps/rest/2.0/search/am/user/"
Request body
<?xml version="1.0" encoding="UTF-8" ?>
<ServiceRequest>
<filters>
<Criteria field="roleName" operator="EQUALS">READER</Criteria>
</filters>
<preferences>
<limitResults>500</limitResults>
</preferences>
</ServiceRequest>
Response
<?xml version="1.0" encoding="UTF-8"?>
<ServiceResponse
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="qualys_base_url/qps/xsd/2.0/am/user.xsd">
<responseCode>SUCCESS</responseCode>
<count>10</count>
<hasMoreRecords>false</hasMoreRecords>
<data>
<User>
<id>490457205</id>
<username>quays_test1</username>
<firstName>quays</firstName>
<lastName>test1</lastName>
<emailAddress>[email protected]</emailAddress>
<title>test</title>
<scopeTags>
<list>
<TagData>
<id>19298013</id>
<name>3.11.0.0</name>
</TagData>
..
</list>
</scopeTags>
<roleList>
<list>
<RoleData>
<id>3222759</id>
<name>PATCH READER</name>
</RoleData>
..
</list>
</roleList>
</User>
</data>
</ServiceResponse>