getteaminfo.do

APIs

The getteaminfo.do call returns the teaminfo_version, team_name, can_view_shared_types, and business_unit parameters of a specific team. If you want to return the user and/or application information, you can pass those optional parameters.

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

Resource URL

https://analysiscenter.veracode.com/api/3.0/getteaminfo.do

Permissions

Non-human user accounts require the Admin API role to use this call. Human user accounts require the Administrator role to use this call.

Parameters

team_id Integer. Required.
include_users String. Optional. Enter Yes to view the members of the team. The default is No.
include_applications String. Optional. Enter Yes to view applications assigned to the team. The default is No.

Example

curl --compressed -u <VeracodeUsername>:<VeracodePassword>
          https://analysiscenter.veracode.com/api/3.0/getteaminfo.do -F team_id="1458" -F
          "include_users=yes" -F "include _applications=yes"> teaminfo.xml

Results

The getteaminfo.do call returns the teaminfo XML document, which references the teaminfo.xsd. Additional teaminfo.xsd documentation is available. Use the XSD file to validate the XML data. The following is an example of the return XML:
<teaminfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://analysiscenter.veracode.com/schema/teaminfo/3.0" xsi:schemaLocation="https://analysiscenter.veracode.com/schema/teaminfo/3.0 https://analysiscenter.veracode.com/resource/3.0/teaminfo.xsd " teaminfo_version="3.1" team_name="Team1" can_view_shared_types="false" business_unit="BU1">
<user username="lead1" first_name="lead1" last_name="lead1" email_address="lead1@vera.com"/>
<user username="lead2" first_name="lead2" last_name="lead2" email_address="lead2@vera.com"/>
<application app_id="11911" app_name="App1" assessment_type="SDLC" account_id="10997" business_unit="BU1"/>
<application app_id="11912" app_name="App2" assessment_type="COTS" account_id="10997" business_unit="BU2"/>
</teaminfo>