---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../../modules.md) / [clients](../index.md) / buildCommerceApiRoleTenantFilter

# Function: buildCommerceApiRoleTenantFilter()

> **buildCommerceApiRoleTenantFilter**(`tenants`): `string`

Defined in: [packages/b2c-tooling-sdk/src/clients/am-provisioning.ts:81](https://github.com/SalesforceCommerceCloud/b2c-developer-tooling/blob/d7ff38c7ca2b1411cd718b9554500c9416f00266/packages/b2c-tooling-sdk/src/clients/am-provisioning.ts#L81)

Build the role tenant filter for a `SALESFORCE_COMMERCE_API` client scoped to
`tenants`, e.g. `SALESFORCE_COMMERCE_API:zzzz_001,zzzz_002`.

## Parameters

### tenants

readonly `string`[]

## Returns

`string`

## Throws

Error when `tenants` is empty or the result doesn't match `ROLE_TENANT_FILTER_PATTERN`
