List Authentication Records

For API version information, refer to the API Version History section.

V2.0

GET POST/api/2.0/fo/auth/?action=list

List all authentication records visible to the user for all technologies (i.e. Windows, Unix, Docker, etc).

A maximum of 1,000 authentication records can be processed per request. If the requested list identifies more than 1,000 authentication records, then the XML output includes the <WARNING> element and instructions for making another request for the next batch of records.

Input ParametersInput Parameters

Parameter	Required/Optional	Data Type	Description
action=list	Required	String	Specify action to list auth records.
echo_request={0\|1}	Optional	Integer	Specify 1 to view (echo) input parameters in the XML output. By default these are not included.
title={value}	Optional	String	Show only authentication records which have a certain string in the record title.
comments={value}	Optional	String	Show only authentication records which have a certain string in the record comments.
ids={value}	Optional	Integer	Show only authentication records with certain IDs and/or ID ranges. Multiple entries are comma separated. One or more IDs/ranges may be specified. An ID range entry is specified with a hyphen (for example, 3000-3250). Valid IDs are required.
id_min={value}	Optional	Integer	Show only authentication records which have a minimum ID value. A valid ID is required.
id_max={value}	Optional	Integer	Show only authentication records which have a maximum ID value. A valid ID is required.

Sample - List Authentication Records, Multiple TechnologiesSample - List Authentication Records, Multiple Technologies

API Request

curl -u "USERNAME:PASSWD" -H "X-Requested-With: curl" -d "action=list" "https://<qualys_base_url>/api/2.0/fo/auth/"

XML Output

<AUTH_ LIST_OUTPUT>
  <RESPONSE>
    <DATETIME>2018-02-12T13:32:17Z</DATETIME>
    <AUTH_RECORDS>
      <AUTH_UNIX_RECORDS>
        <ID_SET>
          <ID_RANGE>17-41</ID_RANGE>
          <ID_RANGE>62-119</ID_RANGE>
        </ID_SET>
      </AUTH_UNIX_RECORDS>
      <AUTH_WINDOWS_RECORDS>
        <ID_SET>
          <ID_RANGE>1-6</ID_RANGE>
        </ID_SET>
      </AUTH_WINDOWS_RECORDS>
      <AUTH_ORACLE_RECORDS>
        <ID_SET>
          <ID>7</ID>
        </ID_SET>
      </AUTH_ORACLE_RECORDS>
      <AUTH_SNMP_RECORDS>
        <ID_SET>
          <ID>4114</ID>
          <ID_RANGE>4117-4121</ID_RANGE>
        </ID_SET>
      </AUTH_SNMP_RECORDS>
      <AUTH_IBM_DB2_RECORDS>
        <ID_SET>
          <ID>6</ID>
        </ID_SET>
      </AUTH_IBM_DB2_RECORDS>
    </AUTH_RECORDS>
  </RESPONSE>
</AUTH_LIST_OUTPUT>

DTD

<platform API server>/api/2.0/fo/auth/auth_records.dtd

V3.0

GET POST/api/3.0/fo/auth/?action=list

List all authentication records visible to the user for all technologies (i.e. Windows, Unix, Docker, etc).

Input ParametersInput Parameters

Parameter	Required/Optional	Data Type	Description
action=list	Required	String	Specify action to list auth records.
echo_request={0\|1}	Optional	Integer	Specify 1 to view (echo) input parameters in the XML output. By default these are not included.
title={value}	Optional	String	Show only authentication records which have a certain string in the record title.
comments={value}	Optional	String	Show only authentication records which have a certain string in the record comments.
ids={value}	Optional	Integer	Show only authentication records with certain IDs and/or ID ranges. Multiple entries are comma separated. One or more IDs/ranges may be specified. An ID range entry is specified with a hyphen (for example, 3000-3250). Valid IDs are required.
id_min={value}	Optional	Integer	Show only authentication records which have a minimum ID value. A valid ID is required.
id_max={value}	Optional	Integer	Show only authentication records which have a maximum ID value. A valid ID is required.

Sample - List All Authentication Records, Multiple TechnologiesSample - List All Authentication Records, Multiple Technologies

API Request

curl -s -S -H 'X-Requested-With:curl demo2' -u "xx_xx:yyyy123#" -d "action=list" "https://<qualys_base_url>/api/3.0/fo/auth/" >

XML Output

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE AUTH_RECORDS_OUTPUT SYSTEM "https://<qualys_base_url>/api/3.0/fo/auth/auth_records.dtd">
<AUTH_RECORDS_OUTPUT>
<auth_records_output>
  <response>
    <datetime>2024-08-23T13:47:54Z</datetime>
    <auth_records>
      <auth_unix_ids>
        <id_set>
          <id>679711</id>
          <id>712175</id>
          <id>958037</id>
          <id>969642</id>
          <id>970675</id>
          <id>970701</id>
          <id>1020544</id>
          <id>1021490</id>
          <id>1022582</id>
          <id>1027482</id>
          <id>1029201</id>
          <id>1091106</id>
          <id>1360974</id>
          <id>1392739</id>
          <id>1393194</id>
          <id>1581709</id>
          <id>1583235</id>
          <id>1701011</id>
          <id>1712145</id>
          <id>1794631</id>
          <id>1806617</id>
          <id>1906524</id>
          <id>2103582</id>
          <id>2118696</id>
          <id>2133877</id>
          <id>2166583</id>
          <id>2455332</id>
          <id>2473316</id>
          <id>2511930</id>
          <id>2568251</id>
          <id>4673941</id>
          <id>4705032</id>
          <id>4724564</id>
          <id>4747900</id>
          <id>4911033</id>
          <id>5073704</id>
          <id>5117459</id>
          <id>5117575</id>
          <id>5190356</id>
          <id>5190862</id>
          <id>5207344</id>
          <id>5295916</id>
          <id_range>2132864-2132865</id_range>
          <id_range>4706061-4706062</id_range>
          <id_range>4706066-4706069</id_range>
        </id_set>
      </auth_unix_ids>
      <auth_windows_ids>
        <id_set>
          <id>679712</id>
          <id>712176</id>
          <id>958039</id>
          <id>965457</id>
          <id>1027642</id>
          <id>1360982</id>
          <id>1699734</id>
          <id>1866874</id>
          <id>2113307</id>
          <id>2266692</id>
          <id>2394475</id>
          <id>2442301</id>
          <id>2455489</id>
          <id>5043106</id>
          <id>5117580</id>
          <id>5256821</id>
          <id>5256826</id>
          <id_range>4704738-4704739</id_range>
        </id_set>
      </auth_windows_ids>
      <auth_oracle_ids>
        <id_set>
          <id>768181</id>
          <id>971683</id>
          <id>1371740</id>
          <id>1371746</id>
          <id>1403716</id>
          <id>5190863</id>
          <id_range>5190867-5190868</id_range>
        </id_set>
      </auth_oracle_ids>
      <auth_snmp_ids>
        <id_set>
          <id>2118698</id>
        </id_set>
      </auth_snmp_ids>
      <auth_ms_sql_ids>
        <id_set>
          <id>2047865</id>
          <id>2266695</id>
          <id>2266910</id>
          <id>5089360</id>
          <id>5091262</id>
          <id>5091305</id>
          <id>5091325</id>
          <id>5092864</id>
          <id>5092910</id>
          <id>5092938</id>
          <id>5092966</id>
          <id>5093027</id>
          <id_range>4713871-4713872</id_range>
          <id_range>5089353-5089356</id_range>
          <id_range>5089363-5089368</id_range>
        </id_set>
      </auth_ms_sql_ids>
      <auth_ibm_db2_ids>
        <id_set>
          <id>2134085</id>
        </id_set>
      </auth_ibm_db2_ids>
      <auth_vmware_ids>
        <id_set>
          <id>1420676</id>
          <id>1424399</id>
          <id_range>2444361-2444363</id_range>
        </id_set>
      </auth_vmware_ids>
      <auth_apache_ids>
        <id_set>
          <id>5096496</id>
          <id>5096516</id>
        </id_set>
      </auth_apache_ids>
      <auth_sybase_ids>
        <id_set>
          <id>1033098</id>
          <id>1033101</id>
          <id>5243997</id>
          <id>5244016</id>
          <id>5257415</id>
          <id>5257664</id>
          <id>5257675</id>
          <id>5258797</id>
          <id>5275407</id>
          <id>5275542</id>
          <id>5275725</id>
          <id_range>5238874-5238875</id_range>
          <id_range>5240379-5240380</id_range>
        </id_set>
      </auth_sybase_ids>
      <auth_mysql_ids>
        <id_set>
          <id>5145480</id>
          <id>5190357</id>
        </id_set>
      </auth_mysql_ids>
      <auth_tomcat_ids>
        <id_set>
          <id>712177</id>
          <id>712187</id>
          <id>712226</id>
          <id>712239</id>
          <id>1701036</id>
          <id>2118902</id>
        </id_set>
      </auth_tomcat_ids>
      <auth_oracle_weblogic_ids>
        <id_set>
          <id>1726135</id>
          <id>2134083</id>
        </id_set>
      </auth_oracle_weblogic_ids>
      <auth_postgresql_ids>
        <id_set>
          <id>1026647</id>
          <id>4706073</id>
          <id>4706075</id>
          <id>4706077</id>
          <id>4706214</id>
          <id>4706324</id>
          <id>4706404</id>
          <id>4706412</id>
          <id>4706517</id>
          <id>5117568</id>
          <id>5117572</id>
        </id_set>
      </auth_postgresql_ids>
      <auth_mongodb_ids>
        <id_set>
          <id>2157859</id>
          <id>2230895</id>
          <id>2283004</id>
          <id>2338797</id>
          <id>2455264</id>
          <id>2455455</id>
          <id>2455462</id>
          <id>2456400</id>
          <id>2456537</id>
          <id>2456539</id>
          <id>4684335</id>
          <id>4713666</id>
          <id>4713674</id>
          <id>4713717</id>
          <id>4713729</id>
          <id>4713874</id>
          <id>5109024</id>
          <id>5109027</id>
          <id_range>2455458-2455460</id_range>
          <id_range>2455464-2455465</id_range>
          <id_range>2456530-2456535</id_range>
          <id_range>5190864-5190866</id_range>
        </id_set>
      </auth_mongodb_ids>
      <auth_vcenter_ids>
        <id_set>
          <id>1423522</id>
          <id>2118903</id>
          <id>2442690</id>
          <id>4684441</id>
          <id_range>2444364-2444365</id_range>
        </id_set>
      </auth_vcenter_ids>
      <auth_mariadb_ids>
        <id_set>
          <id>5238876</id>
        </id_set>
      </auth_mariadb_ids>
      <auth_informixdb_ids>
        <id_set>
          <id_range>1027159-1027160</id_range>
          <id>4747926</id>
        </id_set>
      </auth_informixdb_ids>
      <auth_network_ssh_ids>
        <id_set>
          <id>1043882</id>
          <id>1043889</id>
          <id>1044112</id>
          <id>1044118</id>
          <id>1044161</id>
          <id>1044241</id>
          <id>1052473</id>
          <id>1052553</id>
          <id>2118697</id>
          <id>4713865</id>
          <id_range>1044121-1044123</id_range>
          <id_range>1044158-1044159</id_range>
          <id_range>1051721-1051722</id_range>
        </id_set>
      </auth_network_ssh_ids>
      <auth_nginx_ids>
        <id_set>
          <id>2134081</id>
          <id>2473317</id>
        </id_set>
      </auth_nginx_ids>
      <auth_infoblox_ids>
        <id_set>
          <id>2473315</id>
          <id>4675302</id>
          <id>4675307</id>
          <id>4675316</id>
          <id>4675462</id>
          <id>4675478</id>
          <id>4675502</id>
          <id>4675526</id>
          <id>4713979</id>
        </id_set>
      </auth_infoblox_ids>
      <auth_bind_ids>
        <id_set>
          <id>4703222</id>
        </id_set>
      </auth_bind_ids>
      <auth_cisco_apic_ids>
        <id_set>
          <id>4673926</id>
          <id>4673946</id>
          <id>4675278</id>
          <id>4675281</id>
          <id>4675313</id>
          <id>4704529</id>
          <id>4713981</id>
        </id_set>
      </auth_cisco_apic_ids>
      <auth_cassandra_ids>
        <id_set>
          <id>4703223</id>
          <id>4713982</id>
          <id>4724463</id>
          <id>5207337</id>
          <id>5341160</id>
          <id>5360963</id>
          <id>5364286</id>
          <id>5380621</id>
          <id>5380623</id>
          <id>5380626</id>
          <id>5380730</id>
        </id_set>
      </auth_cassandra_ids>
      <auth_marklogic_ids>
        <id_set>
          <id>4702420</id>
          <id>4706451</id>
          <id>4713859</id>
          <id>4714410</id>
          <id>4714415</id>
          <id>4714429</id>
          <id>4714432</id>
          <id>4714439</id>
          <id>5140524</id>
          <id>5140530</id>
          <id>5140534</id>
          <id_range>4714287-4714288</id_range>
          <id_range>4714384-4714387</id_range>
        </id_set>
      </auth_marklogic_ids>
      <auth_datastax_ids>
        <id_set>
          <id>5291284</id>
          <id>5295929</id>
          <id>5296333</id>
          <id>5305719</id>
          <id>5305752</id>
          <id>5341133</id>
          <id>5341154</id>
          <id>5360961</id>
          <id>5360967</id>
          <id>5361070</id>
          <id>5363948</id>
          <id>5363958</id>
          <id>5363961</id>
          <id>5363973</id>
          <id>5364270</id>
          <id>5364298</id>
          <id>5380620</id>
          <id>5380622</id>
          <id>5380625</id>
          <id>5380731</id>
        </id_set>
      </auth_datastax_ids>
    </auth_records>
  </response>
</auth_records_output>

DTD

<platform API server>/api/3.0/fo/auth/auth_records.dtd

API Version History

The following table depicts the information about the different versions of this API along with the status:

API version	API Status	Release Date
/api/2.0/fo/auth/?action=list	To be Deprecated	March 2025
/api/3.0/fo/auth/?action=list	Active	September 2024