Snyk/groups
@webframp/snyk/groupsv2026.07.20.2
01README
Snyk Groups — group management, orgs, members, and audit
02Release Notes
2026.07.20.2
Fixed: The create_group_export method wrote its resource under the spec
name create_group_export, but the resource schema is registered under the
noun-only key group_export. The write therefore targeted an undeclared
resource spec. The method now writes to the declared group_export spec.
Upgrade note: Data from create_group_export is now written under the
group_export resource spec instead of create_group_export. Queries or stored
resources keyed on the old spec name should be updated.
03Models
@webframp/snyk/groupsv2026.07.20.2snyk/groups.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| apiToken | string | Snyk API token |
| groupId | string | Snyk group ID |
| version | string | Snyk API version date |
fn list_groups()
Get all groups (Early Access)
fn get_group()
Get Group (Early Access)
fn list_group_audit_logs(cursor?: string, from?: string, to?: string, size?: number, sort_order?: enum, user_id?: string, project_id?: string, events?: string, exclude_events?: string)
Search Group audit logs.
| Argument | Type | Description |
|---|---|---|
| cursor? | string | The ID for the next page of results. |
| from? | string | The start date (inclusive) of the audit logs search. If not specified, the st... |
| to? | string | The end date (exclusive) of the audit logs search. Dates should be formatted ... |
| size? | number | Number of results to return per page. |
| sort_order? | enum | Order in which results are returned. |
| user_id? | string | Filter logs by user ID. |
| project_id? | string | Filter logs by project ID. |
| events? | string | Filter logs by event types, cannot be used in conjunction with exclude_events... |
| exclude_events? | string | Exclude event types from results, cannot be used in conjunctions with events ... |
fn create_group_export(include_deleted?: string, include_deactivated?: string)
Start an export
| Argument | Type | Description |
|---|---|---|
| include_deleted? | string | Optional parameter to include deleted issues in results |
| include_deactivated? | string | Optional parameter to include disabled issues in results |
fn get_group_export(export_id: string)
Get export results
| Argument | Type | Description |
|---|---|---|
| export_id | string | Unique export identifier |
fn get_group_export_job_status(export_id: string)
Get export status
| Argument | Type | Description |
|---|---|---|
| export_id | string | Unique export identifier |
fn list_group_user_org_memberships(user_id?: string, org_name?: string, role_name?: string)
Get list of org memberships of a group user
| Argument | Type | Description |
|---|---|---|
| user_id? | string | The ID of the User |
| org_name? | string | The Name of the org |
| role_name? | string | Filter the response for results only with the specified role. |
fn list_orgs_in_group(name?: string, slug?: string, expand?: enum)
List all organizations in group
| Argument | Type | Description |
|---|---|---|
| name? | string | Only return organizations whose name contains this value. Case insensitive. |
| slug? | string | Only return organizations whose slug exactly matches this value. Case sensitive. |
| expand? | enum | Expand the response with additional fields. When set to `count`, the response... |
fn list_group_policies()
Get group level policies (Early Access)
fn create_group_policy(data: object)
Create a new group level policy (Early Access)
| Argument | Type | Description |
|---|---|---|
| data | object |
fn update_group_policy(policy_id: string, data: object)
Update a group-level policy (Early Access)
| Argument | Type | Description |
|---|---|---|
| policy_id | string | Policy ID |
| data | object |
fn delete_group_policy(policy_id: string)
Delete an group-level policy (Early Access)
| Argument | Type | Description |
|---|---|---|
| policy_id | string | Policy ID |
fn list_assignments(rule_extension_id?: string, org_id?: string, group_id?: string)
List all assignments for a group
| Argument | Type | Description |
|---|---|---|
| rule_extension_id? | string | Filter by rule extension IDs |
| org_id? | string | Filter by organization ID |
| group_id? | string | Filter by group ID |
fn create_assignments(data: unknown)
Create bulk assignments for rule extensions
| Argument | Type | Description |
|---|---|---|
| data | unknown |
fn delete_assignments(id?: string, rule_extension_id?: string)
Delete assignments for rule extensions
| Argument | Type | Description |
|---|---|---|
| id? | string | Filter by IDs |
| rule_extension_id? | string | Filter by rule extension ID |
fn list_secrets_rule_extensions()
Get a list of all secrets rule extensions for the requested Group
fn create_secrets_rule_extension(data: unknown)
Create a secrets rule extension
| Argument | Type | Description |
|---|---|---|
| data | unknown |
fn get_secrets_rule_extension(rule_extension_id: string)
Get a secrets rule extension by rule extension ID
| Argument | Type | Description |
|---|---|---|
| rule_extension_id | string | Unique identifier for a rule extension in request path |
fn update_secrets_rule_extension(rule_extension_id: string, data: unknown)
Update a secrets rule extension by rule extension ID
| Argument | Type | Description |
|---|---|---|
| rule_extension_id | string | Unique identifier for a rule extension in request path |
| data | unknown |
fn delete_secrets_rule_extension(rule_extension_id: string)
Delete a secrets rule extension by rule extension ID
| Argument | Type | Description |
|---|---|---|
| rule_extension_id | string | Unique identifier for a rule extension in request path |
fn update_user(id: string, data?: unknown)
Update a user's role in a group (Early Access)
| Argument | Type | Description |
|---|---|---|
| id | string | The id of the user |
| data? | unknown |
Resources
groups(infinite)— Get all groups (Early Access)
group(infinite)— Get Group (Early Access)
list_group_audit_logs(infinite)— Search Group audit logs.
group_export(infinite)— Start an export
group_export_job_status(infinite)— Get export status
group_user_org_memberships(infinite)— Get list of org memberships of a group user
orgs_in_group(infinite)— List all organizations in group
group_policies(infinite)— Get group level policies (Early Access)
group_policy(infinite)— Create a new group level policy (Early Access)
assignments(infinite)— List all assignments for a group
secrets_rule_extensions(infinite)— Get a list of all secrets rule extensions for the requested Group
secrets_rule_extension(infinite)— Create a secrets rule extension
user(infinite)— Update a user's role in a group (Early Access)
04Previous Versions
2026.07.19.1
2026.07.19.1
Added: Initial code-generated release of @webframp/snyk/groups with 21 methods covering the Snyk groups API surface.
05Stats
A
100 / 100
Downloads
0
Archive size
15.1 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels