getuserlist.do

APIs

The getuserlist.do call returns a list of the Veracode user accounts in your organization.

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

Resource URL

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

There are no required parameters. Use the following parameters to filter the list:

Name Type Description
first_name String First name of the user.
last_name String Last name of the user.
custom_id String Required for SAML users. The SAML Subject field value from the user account.
email_address String Email address for the user.
login_account_type String Specify user or api.
phone String Contact phone number for the user.
teams String Comma-separated list of teams. This filter returns users matching all the listed team names.
roles String (case-sensitive) Comma-separated list of roles. You can filter on these user account roles:
  • Administrator
  • Creator
  • eLearning
  • Executive
  • Mitigation Approver
  • Policy Administrator
  • Reviewer
  • Security Insights
  • Security Lead
  • Submitter
This filter only returns users that match all the listed roles.

You can apply scan permissions to these types of scans: Static Analysis, DynamicDS, DynamicMP, Discovery, manual, and Dynamic Analysis.

is_saml_user Boolean Specifies if the user has a SAML login.
login_enabled Boolean Specifies if the user can log in.
requires_token Boolean Specifies whether a user must provide a two-factor authentication token.
is_elearning_manager Boolean Specifies if the user is an Veracode eLearning manager.
elearning_manager String First and last name (not the username) of the Veracode eLearning manager. For example, Mary Doe.
elearning_track String Veracode eLearning track name.
elearning_curriculum String Veracode eLearning curriculum name.
keep_elearning_active Boolean Specifies whether the Veracode eLearning subscription rolls over at renewal.
custom_one String Custom field.
custom_two String Custom field.
custom_three String Custom field.
custom_four String Custom field.
custom_five String Custom field.

HTTPie Example

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

http --auth-type=veracode_hmac -o userlist.xml "https://analysiscenter.veracode.com/api/3.0/getuserlist.do" "login_enabled==true" "roles==Creator,Submitter"

HTTPie Results

The getuserlist.do call returns a comma-separated list of usernames in the userlist XML document, which references the userlist.xsd schema file. You can use the XSD schema file to validate the XML data. See the userlist.xsd schema documentation.
<?xml version="1.0" encoding="UTF-8"?>

<userlist 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;userlist&#x2f;3.0" 
      xsi:schemaLocation="https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;schema&#x2f;userlist&#x2f;3.0 
      https&#x3a;&#x2f;&#x2f;analysiscenter.veracode.com&#x2f;resource&#x2f;3.0&#x2f;userlist.xsd" userlist_version="3.0" 
      account_id="<account id"><filters/>
   <users usernames="aswallowtail&#x40;example.com,lpieris&#x40;example.com,sviceroy&#x40;example.com,
      tmonarch&#x40;example.com,wbuckeye&#x40;example.com"/>
</userlist>