Veracode

Prev Next

Overview

The Clarity Veracode connector talks to the Veracode Identity API, the API Veracode provides for managing the users, teams and roles of your organization.

What Clarity syncs / writes

Veracode source

Direction

Users, with each user’s teams and roles

GET /api/authn/v2/users

read

Roles

GET /api/authn/v2/roles

read

Teams (all teams in the organization, not only the API account’s own)

GET /api/authn/v2/teams

read

Connection test

GET /api/authn/v2/users/self, then GET /api/authn/v2/users

read

Create a user

POST /api/authn/v2/users

write

Add a user to a team

PUT /api/authn/v2/teams/{id}

write

Grant a role, remove a role, remove a user from a team

PUT /api/authn/v2/users/{id}

write

Deactivate a user

PUT /api/authn/v2/users/{id} (sets the user inactive)

write

Delete a user

DELETE /api/authn/v2/users/{id}

write

Authentication uses a Veracode API ID and API secret key. Clarity signs every request with Veracode’s HMAC scheme. There is no OAuth or browser consent step.

Status note: Clarity imports a Veracode user as active only when the user is both active and allowed to sign in. Everyone else is imported as inactive. Clarity can still remove roles and teams from inactive users.

Prerequisites

The API credentials must belong to one of these Veracode accounts (Veracode: Identity API):

  • (a) an API Service Account with the Admin API role, or

  • (b) a human user with the Administrator role who generated API credentials for themselves.

Any other account can sign in to the API, but Veracode refuses to list or change users for it, and Clarity’s connection test fails. This is the most common reason the connector does not work. Accounts that hold only roles such as Security Lead, Creator, Submitter or Reviewer are not enough.

You also need to know which Veracode region your organization uses. See Step 2.

Step 1 — Get API credentials for a qualifying account

Choose one option.

Option (a), recommended: an API Service Account.

  1. A Veracode Administrator creates an API Service Account user and gives it the Admin API role.

  2. Generate API credentials for that account. Veracode returns an API ID and an API secret key.

Option (b): a human Administrator.

  1. Sign in to Veracode as a user who holds the Administrator role.

  2. Generate API credentials for your own user. Veracode returns an API ID and an API secret key.

Needs confirmation: the exact Veracode console menus for creating an API Service Account and generating credentials are not reproduced here. Follow Veracode’s own instructions for API credentials and the Identity API. What matters to Clarity is the result: an API ID and secret key that belong to an account in (a) or (b) above.

⚠️ Copy the secret key when Veracode shows it. Veracode API credentials also expire. When you rotate them, update both values in Clarity, and make sure the new credentials still belong to a qualifying account. A rotation onto a different, lower-privileged account is a common cause of a sudden “access denied”.

Step 2 — Check your region

Veracode runs separate regions, each with its own API host. You can tell yours from the address you sign in at:

You sign in at

Region

API host Clarity calls

analysiscenter.veracode.com

Global

api.veracode.com

analysiscenter.veracode.eu

European

api.veracode.eu

analysiscenter.veracode.us

US Federal (FedRAMP)

api.veracode.us

In most cases you do not need to set anything. Veracode credentials for a regional account start with a short region prefix, for example vera01ei-…. Clarity reads that prefix from the API ID and picks the right host automatically. An API ID without a prefix is treated as Global.

Set the Region field yourself only if your API ID has no prefix and you sign in at the .eu or .us address.

Step 3 — Enter the credentials in Clarity

In Clarity, add a new Veracode application and fill in the Connect App step.

Veracode Connect App step: API ID, API Secret Key and Region fields

Veracode Connect App step: API ID, API Secret Key and Region fields

Clarity field

Required

Value

API ID

Yes

The API ID from Step 1.

API Secret Key

Yes

The API secret key generated with that API ID. The field is masked, and the value is stored encrypted.

Region

No

Leave on Auto-detect from API ID unless Step 2 told you otherwise. The other choices are Global (api.veracode.com), European (api.veracode.eu) and US Federal / FedRAMP (api.veracode.us). A choice you make here always wins over auto-detection.

Region drop-down options

Region drop-down options

Click Next. Clarity checks the credentials before it moves on: it first confirms who the key belongs to, then confirms that the account can list users. If either step fails, Clarity shows “Unable to talk to the service. Please double check your credentials!” and stays on the Connect App step.

Troubleshooting

Symptom

Likely cause

The credential check fails, and the API ID and key were pasted correctly

The account is not an API Service Account with Admin API, or a user with Administrator. Generate credentials for a qualifying account (Step 1).

The credential check fails straight after a key rotation

The new credentials belong to a different or lower-privileged account, or the old credentials have expired.

The credential check fails for an EU or US Federal organization

The API ID has no region prefix. Set Region to European or US Federal / FedRAMP.

A sync completes, but users show no teams or roles

Contact Clarity support with the details below.

If the check still fails, send Clarity support:

  1. Which kind of account the credentials belong to: an API Service Account or a human user.

  2. The roles that account holds in Veracode.

  3. The address you sign in at: analysiscenter.veracode.com, .eu or .us.

  4. Roughly when you last tried the credential check, so we can find the attempt.

When the account can sign in but is refused access to users, Clarity records the roles Veracode reports for that account. With the details above, support can usually tell you exactly which role to add.

What Clarity does NOT do

  • No team or role management. Clarity adds and removes users from existing teams and grants and removes existing roles. It does not create, rename or delete teams or roles.

  • No profile write-back. Clarity does not change a user’s name, email or other profile fields after it creates the user.

  • Limited user creation. Clarity creates a Veracode user only when the application uses single sign-on, or when the application’s default entitlement is a team. New users start with Veracode’s submitter roles.

  • No application-security data. Clarity does not read scans, findings, policies or application profiles. It works only with users and their access.

  • One organization per integration. Each Clarity application manages the Veracode organization its API credentials belong to.

Need Help?

If you have any problems, contact your customer success team. You can also get in touch with our general support via email, open a support ticket. Our general support team is available Monday - Friday from 8:00 AM - 6:30 PM CST.