getuserinfo.do

Veracode APIs

The getuserinfo.do call returns information about the specified user.

Before using this API, Veracode strongly recommends that you read API Usage and Access Guidelines. Ensure you access the APIs with the domain for your region.

REST API Equivalent

The REST API equivalent of this call is a GET to /api/authn/v2/users/{userId} using the Identity API. Veracode strongly recommends that you use the REST API for this action. For new integrations, always use the REST APIs.

Resource URL

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

Permissions

An API service account requires the Admin API role to use this call. A user account requires the Administrator role to use this call.

Parameters

Name Type Description
username

Required

String Required for non-SAML users. Usually the email address of the user.
custom_id

Required

String Required for SAML users. The SAML Subject field value from the user account.

HTTPie Example

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

http --auth-type=veracode_hmac -o userinfo.xml "https://analysiscenter.veracode.com/api/3.0/getuserinfo.do" "[email protected]" 

HTTPie Results

The getuserinfo.do call returns the userinfo XML document, which references the userinfo.xsd schema file. You can use the XSD schema file to validate the XML data.

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

<userinfo 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;userinfo&#x2f;3.0" 
      xsi:schemaLocation="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;userinfo&#x2f;3.0 
      https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;resource&#x2f;3.0&#x2f;userinfo.xsd" userinfo_version="3.0" 
      username="tmonarch&#x40;example.com">
   <login_account first_name="Ted" last_name="Monarch" login_account_type="user" email_address="tmonarch&#x40;example.com" 
      login_enabled="true" requires_token="false" teams="Demo Team" roles="Creator,eLearning,Submitter,Any Scan" 
      is_elearning_manager="false" elearning_manager="No Manager" elearning_track="No Track Assigned" 
      elearning_curriculum="No Curriculum Assigned" keep_elearning_active="false"/>
</userinfo>