Create an API user in the Veracode Platform

You can configure two types of user accounts that can access the Veracode APIs: UI user accounts and API user accounts.

A user account with the required role permissions can access the Results XML API, Upload XML API, and the Mitigation and Comments XML API.

A UI user account with the required role permissions can access the Results XML API, Upload XML API, and the Mitigation and Comments XML API.

In addition, if you have the Administrator role, you can define users who can only access the Veracode APIs. These users are only able to sign in to the Veracode Platform to manage their account and API credentials. For all other tasks, these users must use the Veracode APIs.

note

You can't change an existing UI user account to an API user account. You must create a new user account and select API User.

To complete this task:

1. Sign in to the Veracode Platform.
2. From the gear icon in the upper-right corner, select Admin.
3. On the Users tab, select Add New User.
4. Enter a descriptive first and last name.
5. Select API User.
6. Provide a valid email address for the user. We use this email address to send notifications about error messages, password expirations, and other automated success and error messages.
7. Optionally, define the IP range restrictions for the user.
8. For User Roles, select which APIs the user can access.
9. To create and enable the user, select Save. The user receives an activation email.

Before a user can access the APIs, they must create Veracode API credentials and, optionally, set up API authentication.

Troubleshooting

If the IP range isn't set correctly, the API user can't sign in. If you do not know the IP range for the API user, use the activity log to see the IP address from which the API user is attempting to log in, then grant access to that IP range.

Resetting password for an API user

The process for requesting a password reset is the same for UI user and API user accounts.