Skip to main content

Filter users with the REST API

This use case scenario provides the Identity REST API requests for filtering users. These requests apply to both user accounts and API service accounts.

Send the following request to filter users by role:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?role_id={role_guid}"

Send the following request to filter users by user type:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?user_type={user_type}"

Send the following request to filter users by login status:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?login_status={login_status}"

Send the following request to filter users by SAML status:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?saml_user=true"

Send the following request to filter users by team:

http --auth-type=veracode_hmac GET "https://api.veracode.com/api/authn/v2/users/search?team_id={team_guid}"