Snyk
Snyk is a developer security platform for finding and fixing vulnerabilities in code, open-source dependencies, containers, and infrastructure as code.
- Base URL:
https://api.snyk.io/api/v1 - Auth:
bearer(pass your key via theapiKeyinput)
Operations
list_all_members_in_a_group— GET /group/{groupId}/members — List all members in a grouplist_all_organizations_in_a_group— GET /group/{groupId}/orgs — List all organizations in a grouplist_all_roles_in_a_group— GET /group/{groupId}/roles — List all roles in a groupview_group_settings— GET /group/{groupId}/settings — View group settingslist_all_tags_in_a_group— GET /group/{groupId}/tags — List all tags in a groupget_an_organization_s_entitlement_value— GET /org/{orgId}/entitlement/{entitlementKey} — Get an organization's entitlement value
Inputs
apiKey— your snyk API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: list_all_members_in_a_group
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: list_all_members_in_a_group, list_all_organizations_in_a_group, list_all_roles_in_a_group, view_group_settings, list_all_tags_in_a_group, get_an_organization_s_entitlement_value |
entitlementKey |
string | no | — | Path parameter entitlementKey (required by some operations). |
groupId |
string | no | — | Path parameter groupId (required by some operations). |
orgId |
string | no | — | Path parameter orgId (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |