getuserinfo.do

APIs

The getuserinfo call returns information about the specified user.

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

Resource URL

https://analysiscenter.veracode.com/api/3.0/getuserinfo.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

username String. Required. This is usually the email address of the user.
custom_id String. Required if the username parameter is not provided.

Example

 curl --compressed -u <VeracodeUsername>
        https://analysiscenter.veracode.com/api/3.0/getuserinfo.do -F
        "username=test@example.com"> userinfo.xml

Results

The getuserinfo.do call returns the userinfo XML document, which references the userinfo.xsd. Additional userinfo.xsd schema documentation is available. Use the XSD file to validate the XML data. The following is an example of the returned XML.
<?xml version="1.0" encoding="UTF-8"?>
<userinfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://analysiscenter.veracode.com/schema/userinfo/1.0"​ xsi:schemaLocation="https://analysiscenter.veracode.com/schema/userinfo/1.0 https://analysiscenter.veracode.com/resource/userinfo.xsd"​ username="janeuserl@veracode.com">
<login_account first_name="jane" last_name="smith" login_account_type="user" email_address="janeuserl@veracode.com" ​login_enabled="true" requires_token="true" teams="Team Python" roles="Reviewer,Creator,Any Scan" allowed_ip_addresses="10.1.12.167" last_successful_login_date="2018-07-25T17:15:23-04:00"/>
</userinfo>