Update User Status

V1.0 | V2.0

V1.0 

Use this API to update the user's status. For example, you can change the status from 'Activate' to 'Deactivate'. 

PUT/adminui/user-management/v1/user/status

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 - Update User StatusSample - Update User Status

curl --location --request PUT '<qualys_base_url>/adminui/user-management/v1/user/status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>
--data '{
    "action": "DEACTIVATE",
    "editUser": "<username>"
}'

{
    "userId": 1023557128,
    "username": "<username>",
    "status": "SUCCESS"
}

V2.0 

The new version of this API is compliant to RESTful conventions. The legacy V1 endpoint remain the same. 
With this API, you can activate or deactivate a user. The action field is required and must be either ACTIVATE or DEACTIVATE; an absent, empty, or unrecognized action returns a 400 Bad Request error. This resource-oriented endpoint provides the same capability as the existing v1 update user status API. 

PATCH/adminui/user-management/v2/users/{userId}/status

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. 

Input ParametersInput Parameters

Sample - Deactivate a UserSample - Deactivate a User

curl --location --request PATCH '<qualys_base_url>/adminui/user-management/v2/users/{userId}/status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data-raw '

{
  "action": "DEACTIVATE"
}'

{
  "userId": 1229354639,
  "username": "<username>",
  "status": "SUCCESS"
}