updateuser.do

APIs

The updateuser call updates or changes the information of the specified user account.

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

Resource URL

https://analysiscenter.veracode.com/api/3.0/updateuser.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.
custom_id String. Required for SAML users. The custom_id field is an identifier to inform the system which user it is updating.

The following are optional parameters. Only use them if you need to change the value of any of these parameters. You can use updateuser.do to change any of the parameters that you can change in the Veracode Platform, except for login_account_type. These parameters are also used by the getuserlist.do call.

To change the username, send a new value in the email_address parameter. If is_saml_user is set to true, an error is thrown unless the account has SAML enabled and the login account has or is being given a custom_id. If is_saml_user is being set to false, an error is thrown indicating that SAML users cannot be switched off. If you want to change the custom_id, use the new_custom_id parameter with the new ID.

first_name String.
last_name String.
email_address Valid email address.
phone String.
teams Case-sensitive comma-delimited string. This filter only returns users matching all the listed team names.
roles Case-sensitive comma-delimited string. You can only pass the following human user roles: Administrator, Creator, Executive, Greenlight IDE User, Mitigation Approver, Policy Administrator, Reviewer, Security Lead, Submitter, Security Insights, eLearning, Vendor Manager, Delete Scans, Sandbox Administrator, or Sandbox User. You cannot pass any of the non-human API user roles. If you use either the Creator, Security Lead, or Submitter role, Veracode automatically applies the Any Scan scan permission to the scans.
new_custom_id String. For SAML users to change the identifier of the user account.
has_ip_restriction true or false.
allowed_ip_addresses String. A list of whitelisted IP address from which you can log in. You can only update this list if has_ip_restrictions is set to true.
is_saml_user true or false. You can only update this parameter if your account is SAML-enabled.
login_enabled true or false.
requires_token true or false.
is_elearning_manager true or false. You can only update this parameter if your account has an active eLearning subscription.
elearning_manager String. The first and last name, not the username of the eLearning manager. For example, Mary Doe. You can only update this parameter if your account has an active eLearning subscription.
elearning_track String. The eLearning track name. You can only update this parameter if your account has an active eLearning subscription.
elearning_curriculum String. The eLearning curriculum name. You can only update this parameter if your account has an active eLearning subscription.
keep_elearning_active true or false. You can only update this parameter if your account has an active 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.

Example

curl --compressed -u <VeracodeUsername>
          https://analysiscenter.veracode.com/api/3.0/updateuser.do -F "username=test@example.com"
          -F "email_address=test2@example.com" -F "teams=Admins,Engineers" >output.xml
        

Results

The updateuser.do call returns the output XML document, which references the userinfo.xsd. Additional userinfo.xsd schema documentation is available. Use the XSD file to validate the XML data.