/api/2.0/fo/auth/<type>/?action=list
[GET] [POST]
List authentication records visible to the user for a specific technology (i.e. Unix, Windows, Docker, Sybase etc).
<type> will be a supported technology like: docker, http, ibm_db2, informixdb, kubernetes, mariadb, mongodb, ms_sql, mysql, neo4j, nginx, oracle, oracle_listener, oracle_weblogic, palo_alto_firewall, postgresql, sap_hana, sapiq, snmp, sybase, unix (for Unix, Cisco, Checkpoint Firewall), network_ssh, vmware, windows. For application servers: apache, ms_iis, ibm_websphere, tomcat.
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.
Parameter |
Description |
action=list |
(Required) |
echo_request={0|1} |
(Optional) Specify 1 to view (echo) input parameters in the XML output. By default these are not included. |
enable={0|1} |
(Optional and valid when action is activate) Enable or disable the restricted IPs list. Set enable=1 to enable the list; set enable=0 to clear any IPs in the list and disable the feature. |
title={value} |
(Optional) Show only authentication records which have a certain string in the record title. |
comments={value} |
(Optional) Show only authentication records which have a certain string in the record comments. |
details={Basic|All|None} |
(Optional) Show the requested amount of information for each authentication record. A valid value is: None - show record ID only Basic (default) - show record ID and all authentication record attributes All - show record ID and all authentication record attributes and a glossary section with the user name and login for each record owner |
ids={value} |
(Optional) 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) Show only authentication records which have a minimum ID value. A valid ID is required. |
id_max={value} |
(Optional) Show only authentication records which have a maximum ID value. A valid ID is required. |
Oracle Records |
|
template_auth_id={value} |
(Optional) Specify the template ID for an Oracle system record template to only show Oracle records associated with the specified template. |
template_auth_name={value} |
(Optional) Specify the template name for an Oracle system record template to only show Oracle records associated with the specified template. |
is_template={0|1} |
(Optional) By default, template records and regular Oracle records are listed. Set to 0 to list only regular Oracle records or set to 1 to list only Oracle system record templates. |
status={0|1} |
(Optional) By default, active and inactive auth records are listed. Set to 0 to list only inactive records or set to 1 to list only active records. |
is_system_created={0|1} |
(Optional) By default, user created records and system created auth records are listed. Set to 0 to list only user created records or set to 1 to list only system created records. |
MongoDB Records |
|
template_auth_id={value} |
(Optional) Specify the template ID for an MongoDB system record template to only show MongoDB records associated with the specified template. |
template_auth_name={value} |
(Optional) Specify the template name for an MongoDB system record template to only show MongoDB records associated with the specified template. |
is_template={0|1} |
(Optional) By default, template records and regular MongoDB records are listed. Set to 0 to list only regular MongoDB records or set to 1 to list only MongoDB system record templates. |
status={0|1} |
(Optional) By default, active and inactive auth records are listed. Set to 0 to list only inactive records or set to 1 to list only active records. |
is_system_created={0|1} |
(Optional) By default, user created records and system created auth records are listed. Set to 0 to list only user created records or set to 1 to list only system created records. |
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl demo" -d "action=list&ids=72685" "https://qualysapi.qualys.com/api/2.0/fo/auth/docker/"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_DOCKER_LIST_OUTPUT SYSTEM "https://qualysapi.qualys.com/api/2.0/fo/auth/docker/auth_docker_list_output.dtd">
<AUTH_DOCKER_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2018-03-09T06:11:39Z</DATETIME>
<AUTH_DOCKER_LIST>
<AUTH_DOCKER>
<ID>72685</ID>
<TITLE><![CDATA[docker_sample]]></TITLE>
<DAEMON_CONFIGURATION_FILE>/etc/docker/daemon.json</DAEMON_CONFIGURATION_FILE>
<DOCKER_COMMAND>/usr/bin/docker</DOCKER_COMMAND>
<IP_SET>
<IP>10.10.30.159</IP>
</IP_SET>
<CREATED>
<DATETIME>2018-03-09T06:09:46Z</DATETIME>
<BY>username</BY>
</CREATED>
<LAST_MODIFIED>
<DATETIME>2017-03-09T06:09:46Z</DATETIME>
</LAST_MODIFIED>
</AUTH_DOCKER>
</AUTH_DOCKER_LIST>
</RESPONSE>
</AUTH_DOCKER_LIST_OUTPUT>
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With: curl" -d "action=list&ids=2237956" "https://qualysapi.qualys.com/api/2.0/fo/auth/oracle/"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_ORACLE_LIST_OUTPUT SYSTEM "https://qualysapi.qualys.com/api/2.0/fo/auth/oracle/auth_oracle_list_output.dtd">
<AUTH_ORACLE_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2020-04-23T18:44:27Z</DATETIME>
<AUTH_ORACLE_LIST>
<AUTH_ORACLE>
<ID>2237956</ID>
<TITLE><![CDATA[OracleRecordTemplate]]></TITLE>
<USERNAME><![CDATA[OracleUser]]></USERNAME>
<CREATED>
<DATETIME>2020-04-23T18:43:59Z</DATETIME>
<BY>joe_user</BY>
</CREATED>
<LAST_MODIFIED>
<DATETIME>2020-04-23T18:43:59Z</DATETIME>
</LAST_MODIFIED>
<IS_SYSTEM_CREATED>0</IS_SYSTEM_CREATED>
<IS_ACTIVE>1</IS_ACTIVE>
<IS_TEMPLATE>1</IS_TEMPLATE>
<COMMENTS><![CDATA[my comments]]></COMMENTS>
</AUTH_ORACLE>
</AUTH_ORACLE_LIST>
</RESPONSE>
</AUTH_ORACLE_LIST_OUTPUT>
API request
curl -u "USERNAME:PASSWORD" -H "X-Requested-With:curl" -X POST "action=list&ids=6847704"
"https://qualysapi.qualys.com/api/2.0/fo/auth/mongodb/"
XML output
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE AUTH_MONGODB_LIST_OUTPUT SYSTEM
"https://qualysapi.qualys.com/api/2.0/fo/auth/mongodb/auth_mongodb_list_o
utput.dtd">
<AUTH_MONGODB_LIST_OUTPUT>
<RESPONSE>
<DATETIME>2023-01-05T12:47:03Z</DATETIME>
<AUTH_MONGODB_LIST>
<AUTH_MONGODB>
<ID>6847704</ID>
<TITLE>
<![CDATA[MongoDB system record template]]>
</TITLE>
<USERNAME>
<![CDATA[root]]>
</USERNAME>
<CREDENTIAL_TYPE>
<![CDATA[local]]>
</CREDENTIAL_TYPE>
<LOGIN_TYPE>
<![CDATA[basic]]>
</LOGIN_TYPE>
<REQUIRE_CERT>
<![CDATA[0]]>
</REQUIRE_CERT>
<CREATED>
<DATETIME>2023-01-05T07:16:46Z</DATETIME>
<BY>vt_sm1</BY>
</CREATED>
<LAST_MODIFIED>
<DATETIME>2023-01-05T07:16:46Z</DATETIME>
</LAST_MODIFIED>
<IS_SYSTEM_CREATED>0</IS_SYSTEM_CREATED>
<IS_ACTIVE>1</IS_ACTIVE>
<IS_TEMPLATE>1</IS_TEMPLATE>
</AUTH_MONGODB>
</AUTH_MONGODB_LIST>
</RESPONSE>
</AUTH_MONGODB_LIST_OUTPUT>
<platform API server>/api/2.0/fo/auth/<type>/auth_<type>_list_output.dtd