User Count
Use this API to get the user count details from your subscription.
Input ParametersInput Parameters
|
Parameter |
Mandatory/Optional |
Data Type |
Description |
|---|---|---|---|
|
sortFilter |
Mandatory |
String |
Prvide the value ASC or DESC. |
|
emailAddress |
Mandatory |
String |
Provide the email address. |
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 the User Count DetailsSample - Get the User Count Details
API request
curl --location --request POST '<qualys_base_url>/adminui/user-management/v1/users/count' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <JWT_Token>' \
--data-raw '{
"limit": 50,
"sortFilter": {
"username": "ASC"
},
"filter": {
"emailAddress": "xxxxxxtaxx@qxxxys.com"
},
"groupByCountFilter": "status"
}'
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).
Request Body
{
"users": {
"total": 80,
"ACTIVE": 39,
"PENDING_ACTIVATION": 40,
"INACTIVE": 1
},
"business_units": {
"BU rbac": 3,
"unit BU": 2,
"Unassigned Business Unit": 75
},
"saml": {
"disabled": 77,
"enabled": 3
}
}
API Response
{
"users": {
"total": 137,
"ACTIVE": 112,
"PENDING_ACTIVATION": 25
},
"business_units": {
"BU rbac": 3,
"unit BU": 5,
"Unassigned Business Unit": 129
},
"saml": {
"disabled": 133,
"enabled": 4
}
}