addbrowserbasedlogin.do

Veracode APIs

The addbrowserbasedlogin.do call enables you to provide username and password credentials for browser-based logins when performing a DynamicDS scan.

Before using this API, Veracode strongly recommends that you read API Usage and Access Guidelines.

Resource URL

https://analysiscenter.veracode.com/api/5.0/addbrowserbasedlogin.do

Permissions

You need the Upload API or Upload API - Submit Only role to use this call.

Parameters

Name Type Description
app_id

Required

Integer Application ID.
username

Required

String Username for logging in to the target website.
password

Required

String Password for logging in to the target website.
windows_domain String Windows domain name, if required, for logging in to the target website.

HTTPie Example

Examples use the HTTPie command-line tool. See Using HTTPie with the Python Authentication Library.

http --auth-type=veracode_hmac "https://analysiscenter.veracode.com/api/5.0/addbrowserbasedlogin.do" "app_id==<app id>" "username==<site username>" "password==<site password>" "windows_domain==<site login domain>"

HTTPie Results

The addbrowserbasedlogin.do call returns the dynamic_scan_info XML document, which references the dynamicscaninfo.xsd schema file. You can use the XSD schema file to validate the XML data. See the dynamicscaninfo.xsd schema documentation.

<?xml version="1.0" encoding="UTF-8"?>

<dynamic_scan_info xmlns:xsi="http&#x3a;&#x2f;&#x2f;www.w3.org&#x2f;2001&#x2f;XMLSchema-instance" 
         xmlns="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;4.0&#x2f;dynamicscaninfo" 
         xsi:schemaLocation="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;4.0&#x2f;dynamicscaninfo 
         https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;resource&#x2f;4.0&#x2f;dynamicscaninfo.xsd" 
         account_id="<account id>" app_id="<app id>" scan_id="5028209" error_message="">
   <dynamic_scan scan_id="5028209" scan_name="23 Sep 2019 Dynamic" scan_status="Incomplete" 
         target_url="http&#x3a;&#x2f;&#x2f;tester.co&#x2f;" directory_restriction_policy="true" https_http_inclusion="false">
      <contact_information first_name="Joan" last_name="Smythe" telephone="123-456-7890" email="jsmythe&#x40;example.com"/>
      <allowed_hosts>
         <allowed_host host="http&#x3a;&#x2f;&#x2f;example.com&#x2f;" directory_restriction_policy="dir_and_sub" https_http_inclusion="true"/>
      </allowed_hosts>
      <login>
         <browser_based_login username="<site username>" password="<site password>" windows_domain="<site login domain>"/>
      </login>
   </dynamic_scan>
</dynamic_scan_info>