This use case scenario provides the Identity REST API commands for searching for users. These commands apply to both user accounts and API service accounts.
Use this command to search for users by
username:
http --auth-type=veracode_hmac "https://api.veracode.com/api/authn/v2/users?user_name={user_name}"
You must specify the full username. The command does not support matching partial usernames.
Use this command to search for users by email
address:
http --auth-type=veracode_hmac "https://api.veracode.com/api/authn/v2/users?email_address={email_address},{email_address}"
Note: In each email address, you must specify the @ character using URL encoding or the command
fails. For example, user%40domain.com. To specify multiple addresses, separate
each address with a comma (,).
Use this command to search for users using with partial
terms:
http --auth-type=veracode_hmac "https://api.veracode.com/api/authn/v2/users/search?search_term={search_term}"
You can search for partial strings of the username, first name, last name, or email address. You can combine this call with other search parameters.
Use this command to search for users by API
ID:
http --auth-type=veracode_hmac "https://api.veracode.com/api/authn/v2/users/search?api_id={api_id}"
You must specify the exact API ID. You can combine this call with other search parameters.