Get Authentication Record Details

[GET] /qps/rest/3.0/get/was/webappauthrecord/<id>

View details for an authentication record which is in the user’s scope. Want to find a record ID to use as input? See Search authentication records.

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

Input ParametersInput Parameters

The element “id” (integer) is required, where “id” identifies the authentication record.

Click here for available operators

Sample - View details for the authentication recordSample - View details for the authentication record

Let us view details for authentication record ID 74078.

API request

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

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>
    <data>
        <WebAppAuthRecord>
            <id>74078</id>
            <name>
                <![CDATA[My Authentication Record]]>
            </name>
            <owner>
                <id>4354</id>
                <username>username</username>
                <firstName>
                    <![CDATA[John]]>
                </firstName>
                <lastName>
                    <![CDATA[Smith]]>
                </lastName>
            </owner>
            <formRecord>
                <type>STANDARD</type>
                <sslOnly>true</sslOnly>
                <fields>
                    <count>2</count>
                    <list>
                        <WebAppAuthFormRecordField>
                            <id>826453</id>
                            <name>
                                <![CDATA[name1]]>
                            </name>
                            <value>
                                <![CDATA[value]]>
                            </value>
                        </WebAppAuthFormRecordField>
                        <WebAppAuthFormRecordField>
                            <id>826452</id>
                            <name>
                                <![CDATA[name2]]>
                            </name>
                            <value>
                                <![CDATA[value]]>
                            </value>
                        </WebAppAuthFormRecordField>
                    </list>
                </fields>
            </formRecord>
            <tags>
                <count>1</count>
                <list>
                    <Tag>
                        <id>1418973</id>
                        <name>
                            <![CDATA[Cert Tag]]>
                        </name>
                    </Tag>
                </list>
            </tags>
            <comments>
                <count>0</count>
            </comments>
            <createdDate>2017-09-23T20:21:04Z</createdDate>
            <createdBy>
                <id>4354</id>
                <username>username</username>
                <firstName>
                    <![CDATA[John]]>
                </firstName>
                <lastName>
                    <![CDATA[Smith]]>
                </lastName>
            </createdBy>
            <updatedDate>2017-10-22T05:48:57Z</updatedDate>
            <updatedBy>
                <id>4354</id>
                <username>username</username>
                <firstName>
                    <![CDATA[John]]>
                </firstName>
                <lastName>
                    <![CDATA[Smith]]>
                </lastName>
            </updatedBy>
        </WebAppAuthRecord>
    </data>
</ServiceResponse>
	  

Sample - Password is maskedSample - Password is masked

Let us fetch authentication record details with the password fields masked when sub user has disabled  "View Password in Authentication Record" and "View/download Selenium Script sensitive contents" permissions.

API request

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

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>
    <data>
        <WebAppAuthRecord>
            <id>761533</id>
            <name>
                <![CDATA[Selenium record]]>
            </name>
            <owner>
                <id>75670165</id>
                <username>john_doe</username>
                <firstName>
                    <![CDATA[John]]>
                </firstName>
                <lastName>
                    <![CDATA[Smith]]>
                </lastName>
            </owner>
            <formRecord>
                <type>SELENIUM</type>
                <seleniumScript>
                    <name>
                        <![CDATA[seleniumScript]]>
                    </name>
                    <data>
                        <![CDATA[
                        
                        <?xml version="1.0" encoding="UTF-8"?>
                        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
                        <html
                            xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
                            <head>
                                <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
                                <link rel="selenium.base" href="https://10.113.195.231/" />
                                <title>AuthScript</title>
                            </head>
                            <body>
                                <table cellpadding="1" cellspacing="1" border="1">
                                    <thead>
                                        <tr>
                                            <td rowspan="1" colspan="3">AuthScript</td>
                                        </tr>
                                    </thead>
                                    <tbody>
                                        <tr>
                                            <td>open</td>
                                            <td>@@webappURL@@</td>
                                            <td></td>
                                        </tr>
                                        <tr>
                                            <td>click</td>
                                            <td>name=username</td>
                                            <td></td>
                                        </tr>
                                        <tr>
                                            <td>type</td>
                                            <td>name=username</td>
                                            <td>*****</td>
                                        </tr>
                                        <tr>
                                            <td>type</td>
                                            <td>name=password</td>
                                            <td>*****</td>
                                        </tr>
                                        <tr>
                                            <td>click</td>
                                            <td>name=Login</td>
                                            <td></td>
                                        </tr>
                                    </tbody>
                                </table>
                            </body></html>
	  

Sample - Password is visibleSample - Password is visible

Let us fetch authentication record details with the password fields visible when sub user has disabled  "View Password in Authentication Record" and "View/download Selenium Script sensitive contents" permissions.

API request

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

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>
    <data>
    <WebAppAuthRecord>
        <id>762380</id>
        <name>
        <![CDATA[Selenium with server authentication]]>
        </name>
        <owner>
        <id>75913465</id>
        <username>john_doe</username>
        <firstName>
            <![CDATA[John]]>
        </firstName>
        <lastName>
            <![CDATA[doe]]>
        </lastName>
        </owner>
        <formRecord>
        <type>SELENIUM</type>
        <seleniumScript>
            <name>
            <![CDATA[seleniumScript]]>
            </name>
            <data>
            <![CDATA[
            <?xml version="1.0" encoding="UTF-8"?>
            <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
            <html
                xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
lang="en">
                <head>
                <meta http-equiv="Content-Type" content="text/html;
charset=UTF-8" />
                <link rel="selenium.base" href="https://10.113.195.231/"
/>
                <title>AuthScript</title>
                </head>
                <body>
                <table cellpadding="1" cellspacing="1" border="1">
                    <thead>
                    <tr>
                        <td rowspan="1" colspan="3">AuthScript</td>
                    </tr>
                    </thead>
                    <tbody>
                    <tr>
                        <td>open</td>
                        <td>@@webappURL@@</td>
                        <td></td>
                    </tr>
                    <tr>
                        <td>click</td>
                        <td>name=username</td>
                        <td></td>
                    </tr>
                    <tr>
                        <td>type</td>
                        <td>name=username</td>
                        <td>theuser</td>
                    </tr>
                    <tr>
                        <td>type</td>
                        <td>name=password</td>
                        <td>thepass</td>
                    </tr>
                    <tr>
                        <td>click</td>
                        <td>name=Login</td>
                        <td></td>
                    </tr>
                    </tbody>
                </table>
                </body></html>

XSD

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