Admin XML API (Deprecated)
The Veracode Admin API enables you to automate administration tasks such as creating and managing users and teams in the Veracode Platform and obtaining reference information about your organization.
Veracode has deprecated the Admin XML APIs for user and team management. End-of-support for these APIs is scheduled for June 30, 2023. You must update your automations to use the Identity REST APIs. Also, enabling the Single Sign-on and Just-in-Time Provisioning feature automatically disables the Admin XML APIs for user management.
For example, you can use a script to mass create users, mass assign users to teams, or deprovision many users at once. You can also use the Admin API to automatically connect Veracode to the directory for you your organization (LDAP or Active Directory), so that as changes occur in your directory, such as adding or terminating employees, those changes are automatically reflected in your user list in Veracode.
The Veracode Admin API is a basic HTTPS-based request API that uses simple HTTP calls and returns data in XML format. You can use any technology that supports making HTTP calls and parsing XML to access the API. For performance reasons, the Admin API automatically compresses large XML files using Gzip if your requesting tool supports it. You are strongly encouraged to use a user-agent that supports Gzip to access the Admin API. You can use any tool that supports HTTP to test the API.
REST API Equivalent
The REST API equivalents of these calls are available with the Identity API. Veracode strongly recommends that you use the REST APIs. For new integrations, always use the REST APIs.
- An API service account with the Admin API role or a user account with the Administrator role
- Generated Veracode API credentials
- Ensure you access the APIs with the domain for your region.