data.snyk_issues data source in snyk plugin

[traut]

Description

Snyk is a popular solution for vulnerabilities detection in the code and the applications. Issues created by Snyk should be tracked in the scope of the cyber security practice.

Use Case

Snyk API provides two endpoint for fetching the issues -- per group and per organization:

• /groups/{group_id}/issues endpoint (docs)
• /orgs/{org_id}/issues endpoint (docs)

Requirements

• configuration:
  • api_key - a required string attribute
• parameters:
  • project_id - (optional) a string attribute, must be an UUID
  • group_id - (optional) a string attribute, must be an UUID
  • scan_item_id -- (optional) a string attribute
  • scan_item.type -- (optional) a string attribute. Supported values are project and environment
  • type -- (optional) a string attribute. Supported values are package_vulnerability, license, cloud, code, custom, config.
  • updated_before -- (optional) a string attribute
  • updated_after -- (optional) a string attribute
  • created_before -- (optional) a string attribute
  • created_after -- (optional) a string attribute
  • effective_severity_level -- (optional) a string attribute. Supported values are: info, low, medium, high and critical
  • status -- (optional) an array of strings. Supported array values are open and resolved
  • ignored -- (optional) a boolean attribute
  • limit -- (optional) an int attribute
• constraints:
  • either project_id or group_id attribute must be set

Immutable query parameters:

• version is at least to 2024-01-23

The plugin takes care of pagination according to limit value that limits the number of overall results (not per page!).
The plugin returns the list of issues, concatenated over multiple pages.

Additional Information

• https://docs.snyk.io/snyk-api/authentication-for-api
• https://apidocs.snyk.io/?version=2024-01-23#get-/groups/-group_id-/issues
• https://apidocs.snyk.io/?version=2024-01-23#get-/orgs/-org_id-/issues