Authentication Count

GET POST/qps/rest/3.0/count/was/webappauthrecord

Returns the total number of authentication records in the user’s scope. Input elements are optional and are used to filter the number of authentication records included in the count.

Permissions required - User must have WAS module enabled. User account must have these permissions: Access Permission “API Access” and Asset Management Permission “Read Asset”. The output includes authentication records in the user's scope.

Input ParametersInput Parameters

These elements are optional and act as filters. When multiple elements are specified, parameters are combined using a logical AND. Click here for descriptions of <WebApp> elements

Click here for available operators

Parameter

Mandatory

/Optional

Data Type

Description

id

Optional

integer

Authentication record ID.

name

Optional

text

Authentication record name.

tags

Optional

text

Tag associated with the authentication record.

tags.name

Optional

text

Tag name assigned to the authentication record.

tags.id

Optional

integer

Tag ID assigned to the authentication record.

createdDate

Optional

date

The date when the authentication record was created in WAS, in UTC date/time format.

updatedDate

Optional

date

The date when the authentication record was updated in WAS, in UTC date/time format.

lastScan.date

Optional

date

The date when the web application (associated with the authentication record) was last scanned, in UTC date/time format.

lastScan.authStatus

Optional

keyword

Authentication status reported by the last web application scan: NONE, NOT_USED, SUCCESSFUL, FAILED or PARTIAL

isUsed

Optional

boolean

Indicates whether used by a web application or scan.

contents

Optional

keyword

FORM_STANDARD, FORM_CUSTOM, FORM_SELENIUM, SERVER_BASIC, SERVER_DIGEST, SERVER_NTLM, CERTIFICATE, OAUTH2_AUTH_CODE, OAUTH2_IMPLICIT, OAUTH2_PASSWORD, and OAUTH2_CLIENT_CREDS)

Sample - Get a count of authentication records in the user's accountSample - Get a count of authentication records in the user's account

Return the number (count) of all authentication records in the user’s scope.

API request

curl -u "USERNAME:PASSWORD" <qualys_base_url>/qps/rest/3.0/count/was/webappauthrecord/" 

XML 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/3.0/was/webappauthrecord.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>3</count>
</ServiceResponse>

Sample - Get count of authentication records with a criteriaSample - Get count of authentication records with a criteria

Return the number (count) authentication records that have a name that contains the term “server”.

API request

curl -u "USERNAME:PASSWORD" -H "content-type: text/xml" -X "POST" --data-binary @- "<qualys_base_url>/qps/rest/3.0/count/was/webappauthrecord/" < file.xml
Note: “file.xml” contains the request POST data.

Request POST data

<ServiceRequest>
    <filters>
        <Criteria field="name" operator="CONTAINS">server</Criteria>
    </filters>
</ServiceRequest>
      

XML 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/3.0/was/webappauthrecord.xsd">
    <responseCode>SUCCESS</responseCode>
    <count>1</count>
</ServiceResponse>
      

XSD

<platform API server>/qps/xsd/3.0/was/webappauthrecord.xsd