Snyk/tenants

@webframp/snyk/tenantsv2026.07.20.1· 5d agoMODELS

01README

Snyk Tenants — tenant and organization lifecycle management

02Release Notes

2026.07.20.1

Fixed: Org-scoped methods (paths under /orgs/{org_id}/...) dropped their org_id path parameter. The generated code referenced args.org_id, but the argument was never declared or forwarded, so requests went to /orgs/undefined/... and returned HTTP 404. These methods now declare and forward org_id correctly.

Upgrade note: Org-scoped methods now take a required org_id argument. Calls that previously failed with a 404 succeed once org_id is supplied.

03Models1

snyk/tenants.tsv2026.07.20.1

Global Arguments

Argument	Type	Required	Description
apiToken	string	yes	Snyk API token
version	string	yes	Snyk API version date

fn list_tenants(name?: string)

Get a list of all accessible Tenants

Argument	Type	Required	Description
name?	string	no	Only return tenants whose name contains this value.

fn get_tenant(tenant_id: string)

Get a single Tenant by ID

Argument	Type	Required	Description
tenant_id	string	yes	Unique identifier for tenant

fn update_tenant(tenant_id: string, data?: object)

Update tenant

Argument	Type	Required	Description
tenant_id	string	yes	Unique identifier for tenant
data?	object	no

fn get_broker_connection_integrations(tenant_id: string, connection_id: string)

Get Integrations using the current Broker connection

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
connection_id	string	yes	Connection ID

fn create_broker_connection_integration(tenant_id: string, connection_id: string, org_id: string, data: unknown)

Creates Broker connection Integration Configuration

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
connection_id	string	yes	Connection ID
org_id	string	yes	Org ID
data	unknown	yes

fn delete_broker_connection_integration(tenant_id: string, connection_id: string, org_id: string, integration_id: string)

Deletes an Integration for a Broker connection

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
connection_id	string	yes	Connection ID
org_id	string	yes	Org ID
integration_id	string	yes	Integration ID

fn list_broker_deployments_for_tenant(tenant_id: string)

List Broker deployments for tenant

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID

fn list_connection_contexts(tenant_id: string, install_id: string, connection_id: string)

List Connection contexts

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
connection_id	string	yes	Connection ID

fn get_connection_context(tenant_id: string, install_id: string, context_id: string)

List Connection context

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
context_id	string	yes	Context ID

fn update_broker_context(tenant_id: string, install_id: string, context_id: string, data: object)

Updates Broker Context

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
context_id	string	yes	Context ID
data	object	yes

fn delete_broker_context(tenant_id: string, install_id: string, context_id: string)

Deletes broker context

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
context_id	string	yes	Context ID

fn update_broker_context_integration(tenant_id: string, install_id: string, context_id: string, data: object)

Updates an integration to be associated with a Broker context

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
context_id	string	yes	Context ID
data	object	yes

fn delete_broker_context_integration(tenant_id: string, install_id: string, context_id: string, integration_id: string)

Deletes the Broker context association with an Integration

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
context_id	string	yes	Context ID
integration_id	string	yes	Integration ID

fn list_broker_deployments(tenant_id: string, install_id: string)

List Broker deployments

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID

fn create_broker_deployment(tenant_id: string, install_id: string, data: object)

Creates Broker Deployment

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
data	object	yes

fn update_broker_deployment(tenant_id: string, install_id: string, deployment_id: string, data: unknown)

Updates Broker deployment

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID
data	unknown	yes

fn delete_broker_deployment(tenant_id: string, install_id: string, deployment_id: string)

Deletes Broker deployment

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID

fn list_broker_connections(tenant_id: string, install_id: string, deployment_id: string)

List Broker connections

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID

fn create_broker_connection(tenant_id: string, install_id: string, deployment_id: string, data: object)

Creates Broker connection

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID
data	object	yes

fn delete_broker_connections(tenant_id: string, install_id: string, deployment_id: string)

Deletes Broker connections

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID

fn get_broker_connection(tenant_id: string, install_id: string, deployment_id: string, connection_id: string)

Get Broker connection

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID
connection_id	string	yes	Connection ID

fn update_broker_connection(tenant_id: string, install_id: string, deployment_id: string, connection_id: string, data: object)

Updates Broker connection

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID
connection_id	string	yes	Connection ID
data	object	yes

fn delete_broker_connection(tenant_id: string, install_id: string, deployment_id: string, connection_id: string)

Deletes Broker connection

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID
connection_id	string	yes	Connection ID

fn list_broker_orgs_for_bulk_migration(connection_id: string, deployment_id: string, install_id: string, tenant_id: string)

List organizations for bulk migration

Argument	Type	Required	Description
connection_id	string	yes	Connection ID
deployment_id	string	yes	Deployment ID
install_id	string	yes	Install ID
tenant_id	string	yes	Tenant ID

fn create_broker_orgs_for_bulk_migration(connection_id: string, deployment_id: string, install_id: string, tenant_id: string, data: object)

Performs bulk migration integrations to universal broker

Argument	Type	Required	Description
connection_id	string	yes	Connection ID
deployment_id	string	yes	Deployment ID
install_id	string	yes	Install ID
tenant_id	string	yes	Tenant ID
data	object	yes

fn list_deployment_contexts(tenant_id: string, install_id: string, deployment_id: string)

List Deployment contexts

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID

fn create_broker_context(tenant_id: string, install_id: string, deployment_id: string, data: object)

Create broker Context

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID
data	object	yes

fn list_deployment_credentials(tenant_id: string, install_id: string, deployment_id: string)

List Deployment credentials

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID

fn create_deployment_credential(tenant_id: string, install_id: string, deployment_id: string, data: object)

Create deployment credential

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID
data	object	yes

fn get_deployment_credential(tenant_id: string, install_id: string, deployment_id: string, credential_id: string)

Get Deployment credential

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID
credential_id	string	yes	Credential ID

fn update_deployment_credential(tenant_id: string, install_id: string, deployment_id: string, credential_id: string, data: unknown)

Updates Deployment credential

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID
credential_id	string	yes	Credential ID
data	unknown	yes

fn delete_deployment_credential(tenant_id: string, install_id: string, deployment_id: string, credential_id: string)

Deletes Deployment credential

Argument	Type	Required	Description
tenant_id	string	yes	Tenant ID
install_id	string	yes	Install ID
deployment_id	string	yes	Deployment ID
credential_id	string	yes	Credential ID

fn list_assets_tenant(tenant_id: string, filter?: string, sort?: string, fields?: string, meta_count?: enum)

List or search all assets (synchronous) (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
filter?	string	no	RSQL filter expression for filtering results. See schema for full documentation.
sort?	string	no	Comma-separated sort fields. Prefix with `-` for descending order. **Supporte...
fields?	string	no	Sparse fieldsets allow clients to request only specific fields for a given re...
meta_count?	enum	no	Provide summary count in the response meta object when requested. When `with`...

fn update_assets_bulk_tenant(tenant_id: string, data: array)

Bulk update asset attributes (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
data	array	yes

fn get_filter_fields_tenant(tenant_id: string, asset_types?: string)

Get available filter fields (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
asset_types?	string	no	Comma-separated list of asset types to filter the available filter fields

fn get_filter_values_tenant(tenant_id: string, filter_id: string, q?: string, keys_only?: boolean, key?: string)

Get filter value suggestions (autocomplete) (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
filter_id	string	yes	The UUID of the filter field to get values for (from the filter fields list e...
q?	string	no	Full text search term to filter the list of values. If keys_only is true, thi...
keys_only?	boolean	no	Return only the keys of the object filter values
key?	string	no	Return only the value for a specific key of the object filter values

fn get_group_fields_tenant(tenant_id: string, asset_types?: string)

Get available group fields (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
asset_types?	string	no	Comma-separated list of asset types to filter the available group fields

fn get_group_values_tenant(tenant_id: string, group_field_id: string, asset_types?: string, filter?: string, sort?: string, meta_fields?: string, aggregate?: string)

Get group value aggregation (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
group_field_id	string	yes	The UUID of the group field to get values for (from the group fields list end...
asset_types?	string	no	Comma-separated list of asset types to filter the aggregation
filter?	string	no	RSQL filter expression for filtering which assets are included in aggregation...
sort?	string	no	Comma-separated sort fields for group values. Prefix with `-` for descending ...
meta_fields?	string	no	Meta fields to include in the response. Multiple fields can be specified. Ava...
aggregate?	string	no	Per-field aggregate function override for meta fields. All fields default to ...

fn create_asset_search_tenant(tenant_id: string, data?: object)

Create an asset search (asynchronous) (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
data?	object	no

fn get_asset_search_results_tenant(tenant_id: string, search_id: string, sort?: string, fields?: string)

Retrieve asset search results (asynchronous) (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
search_id	string	yes	The unique identifier of the search operation
sort?	string	no	Comma-separated sort fields. Prefix with `-` for descending order. **Supporte...
fields?	string	no	Sparse fieldsets allow clients to request only specific fields for a given re...

fn get_asset_tenant(tenant_id: string, asset_id: string, fields?: string)

Get a single asset by ID (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
asset_id	string	yes	The unique identifier of the asset
fields?	string	no	Sparse fieldsets allow clients to request only specific fields for a given re...

fn update_asset_tenant(tenant_id: string, asset_id: string, data: unknown)

Update asset attributes (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
asset_id	string	yes	The unique identifier of the asset
data	unknown	yes

fn list_asset_projects_tenant(tenant_id: string, asset_id: string, canonical?: enum, target_id?: string, sort?: enum)

List projects for an asset (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
asset_id	string	yes	The unique identifier of the asset
canonical?	enum	no	Filter projects by canonical status. - `with`: Returns all projects (canonica...
target_id?	string	no	Filter projects by target ID. When provided, returns only projects that belon...
sort?	enum	no	Sort field with optional direction prefix. Prefix with `-` for descending ord...

fn list_asset_targets_tenant(tenant_id: string, asset_id: string)

List targets for an asset (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	The unique identifier of the tenant
asset_id	string	yes	The unique identifier of the asset

fn get_tenant_memberships(tenant_id: string, sort_by?: enum, sort_order?: enum, email?: string, user_id?: string, name?: string, username?: string, connection_type?: string, role_name?: string)

Get all memberships of the tenant (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	Unique identifier of the tenant.
sort_by?	enum	no	Which column to sort by.
sort_order?	enum	no	Order in which results are returned.
email?	string	no	Filter the response by Users that match the provided email
user_id?	string	no	Filter the response by Users that match the provided user ID
name?	string	no	Filter the response by Users that match the provided name
username?	string	no	Filter the response by Users that match the provided username
connection_type?	string	no	Filter the response by Users that match the provided connection type
role_name?	string	no	Filter the response for results only with the specified role.

fn update_tenant_membership(tenant_id: string, membership_id: string, data: unknown)

Update tenant membership (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	Unique identifier of the tenant.
membership_id	string	yes	Unique identifier of the tenant membership.
data	unknown	yes

fn delete_tenant_membership(membership_id: string, tenant_id: string)

Delete an individual tenant membership for a single user. (Early Access)

Argument	Type	Required	Description
membership_id	string	yes	Unique identifier of the tenant membership.
tenant_id	string	yes	Unique identifier of the tenant.

fn list_tenant_roles(tenant_id: string, name?: string, custom?: string, assignable_by_me?: string, expand_permissions?: boolean)

List all available roles for a given tenant (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	Unique identifier of the tenant.
name?	string	no	Role name filter.
custom?	string	no	Whether role is custom or not.
assignable_by_me?	string	no	When true, only return roles that the current user can assign to others in th...
expand_permissions?	boolean	no	option to show all permission types

fn create_tenant_role(tenant_id: string, data: object)

Create a custom tenant role for a given tenant (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	Unique identifier of the tenant.
data	object	yes

fn get_tenant_role(tenant_id: string, role_id: string, has_users_assigned?: boolean)

Return a specific role by its id and its tenant id. (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	Unique identifier of the tenant.
role_id	string	yes	Unique identifier of the role.
has_users_assigned?	boolean	no	returns current memberships of the role in the meta relationships section

fn update_tenant_role(tenant_id: string, role_id: string, force?: string, data?: object)

Update a specific tenant role by its id and its tenant id. (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	Unique identifier of the tenant.
role_id	string	yes	Unique identifier of the role.
force?	string	no	flag to force the update of a role, required if users are assigned to the role
data?	object	no

fn delete_tenant_role(tenant_id: string, role_id: string)

Delete a specific tenant role by its id and its tenant id. (Early Access)

Argument	Type	Required	Description
tenant_id	string	yes	Unique identifier of the tenant.
role_id	string	yes	Unique identifier of the role.

04Previous Versions1

2026.07.19.1Jul 20, 2026

2026.07.19.1

Added: Initial code-generated release of @webframp/snyk/tenants with 52 methods covering the Snyk tenants API surface.

05Stats

100 / 100

Downloads

Archive size

26.8 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

Repository

https://github.com/webframp/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#snyk #tenants #organizations #management