updateuser.do (Deprecated)

The updateuser.do call updates the information for the specified Veracode account.

Use updateuser.do to change any of the parameters that you can change in the Veracode Platform, except for login_account_type.

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 PUT 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/updateuser.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 only.
custom_id Required	String	Required for SAML users only. The SAML Subject field value from the user account. The custom_id is an identifier to inform the system which user it is updating. If you want to change the custom_id, use the new_custom_id parameter with the new ID.
first_name	String	First name of the user.
last_name	String	Last name of the user.
email_address	String	Valid email address. To change the username, send a new value in the email_address parameter.
phone	String	Contact phone number for the user.
teams	String (case-sensitive)	Comma-separated list of team names.
roles	String (case-sensitive)	Comma-separated list of these user account roles: Administrator Creator Delete Scans eLearning Executive Greenlight IDE User Mitigation Approver Policy Administrator Reviewer Sandbox Administrator Sandbox User Security Insights Security Lead Submitter Vendor Manager You cannot pass any of the API user roles for API service accounts. If you use either the Creator, Security Lead, or Submitter role, Veracode automatically applies the Any Scan permission to the scans. You can apply scan permissions to these types of scans: Static Analysis, Dynamic Analysis, Discovery, manual, and Dynamic Analysis.
new_custom_id	String	For SAML users to change the identifier of the user account.
has_ip_restrictions	Boolean	Specifies whether the administrator has placed IP restrictions on the user.
is_saml_user	Boolean	You can only update this parameter if your account is SAML-enabled. If your call incorrectly sets is_saml_user to true, you receive an error. The login account must have SAML enabled and have a custom_id. If the account does have SAML enabled but lacks a custom_id, you can set is_saml_user to true and provide the missing custom_id. You cannot set is_saml_user to false, because SAML users cannot be converted to non-SAML users.
login_enabled	Boolean	Specifies whether the user can login.
requires_token	Boolean	Specifies whether a user must provide a two-factor authentication token.
is_elearning_manager	Boolean	You can only update this parameter if your account has an active Veracode eLearning subscription.
elearning_manager	String	The first and last name (not the username) of the Veracode eLearning manager. For example, Mary Doe. You can only update this parameter if your account has an active Veracode eLearning subscription.
elearning_track	String	The Veracode eLearning track name. You can only update this parameter if your account has an active Veracode eLearning subscription.
elearning_curriculum	String	The Veracode eLearning curriculum name. You can only update this parameter if your account has an active Veracode eLearning subscription.
keep_elearning_active	Boolean	You can only update this parameter if your account has an active Veracode eLearning subscription.
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.

http --auth-type=veracode_hmac -o updateduserinfo.xml "https://analysiscenter.veracode.com/api/3.0/updateuser.do" "[email protected]" "phone==111-222-3333"

HTTPie results

The updateuser.do call returns the output 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" 
      phone="111-222-3333" 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>