Update User API
Use this API to update a user in the API user’s scope.
Permissions
User must have the Security Assessment Questionnaire (SAQ) module enabled, the User must have API ACCESS permission, Output includes users within the API user's scope.
Input ParametersInput Parameters
The id (Long) element is required to identify the user of interest. Other elements are optional.
| Parameter | Mandatory/Optional | Data Type | Description | Allowed Operators |
| firstName | Mandatory | Text | First name of the user | CONTAINS, EQUALS, NOT EQUALS |
| lastName | Mandatory | Text | Last name of the user | CONTAINS, EQUALS, NOT EQUALS |
| company | Mandatory | Text | Company of the user |
CONTAINS, EQUALS, NOT EQUALS |
| emailAddress | Mandatory | Text | Email address of the user | CONTAINS, EQUALS, NOT EQUALS |
| title | Mandatory | Text | Title of the user's work profile | CONTAINS, EQUALS, NOT EQUALS |
| tags | Mandatory | List | Tags applied to user | CONTAINS, EQUALS, NOT EQUALS |
| userName | Optional | Text | User name of the user | CONTAINS, EQUALS, NOT EQUALS |
| id | Optional | Integer | ID of the user | CONTAINS, EQUALS, NOT EQUALS |
| uuid | Optional | Integer | Unique id of the user | CONTAINS, EQUALS, NOT EQUALS |
| tags.tag.id | Optional | Integer | Tag id applied to the user | CONTAINS, EQUALS, NOT EQUALS |
| tags.tag.name | Optional | Text | Tag name applied to the user | EQUALS, NOT EQUALS |
Sample - Update a UserSample - Update a User
API Request
curl -u ":<password>"
-H "content-type: text/xml"
-X "POST"
--data-binary @-
"<qualys_base_url>/qps/rest/1.0/update/saq/user/387600" < file.xml
Note: "file.xml" contains the request POST data.
Request POST Data
<?xml version="1.0" encoding="UTF-8"?>
<ServiceRequest>
<data>
<User>
<id>387600</id>
<firstName>user</firstName>
<lastName>user</lastName>
<company>abc</company>
<emailAddress>[email protected]</emailAddress>
</User>
</data>
</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/1.0/saq/user.xsd">
<responseCode>SUCCESS</responseCode>
<count>1</count>
<data>
<User>
<id>387600</id>
<uuid>c54c47ef-57f6-42c8-bdd4-411c5f252234</uuid>
<firstName>user1</firstName>
<lastName>user11</lastName>
<company>abc</company>
<emailAddress>[email protected]</emailAddress>
</User>
</data>
</ServiceResponse>
XSDXSD
<platform API server>/qps/xsd/1.0/saq/user.xsd