Documentation
Feedback
Guides
API Reference

Guides
Guides
B2B Suite
B2B Organizations

Enabling an access control list ACL in B2B Suite

The Access Control List (ACL) feature in B2B Suite allows you to restrict access to resources such as buyer organizations, cost centers, and members in the VTEX Admin. You need to set up specific permissions to allow the users to view or manage these resources.

If a user doesn't have the required permissions, they won't be able to access the Buyer organizations section in the VTEX Admin.

Required permissions

To allow access to the apps related to B2B Organizations in the VTEX Admin, you need to add the following roles:

Permission NameDescription
buyer_organization_viewAllows viewing organizations, cost centers, and users.
buyer_organization_editAllows creating, editing, and deleting organizations, cost centers, and users.

These permissions are available under the Buyer organizations/Management resource. Follow the steps below to access this resource:

  1. Access the VTEX Admin.
  2. In the upper right corner, click the icon with your initial.
  3. Click Account settings.
  4. Click User roles.

Updating B2B Suite apps

To enable the ACL feature, follow the steps below:

  1. Open the terminal Using VTEX IO CLI.
  2. Run the commands below to update the B2B Suite apps.

_13
vtex install vtex.storefront-permissions@3.1.0 --force
_13
vtex install vtex.b2b-organizations-graphql@2.0.1 --force
_13
vtex install vtex.b2b-quotes-graphql@4.0.1 --force
_13
vtex install vtex.b2b-orders-history@2.0.1
_13
vtex install vtex.storefront-permissions-ui@3.0.1
_13
vtex install vtex.b2b-organizations@3.0.1
_13
vtex install vtex.b2b-quotes@3.0.1
_13
vtex install vtex.storefront-permissions-components@2.0.1
_13
vtex install vtex.b2b-admin-customers@2.0.1
_13
vtex install vtex.b2b-my-account@2.0.0
_13
vtex install vtex.b2b-checkout-settings@3.0.1 --force
_13
vtex install vtex.b2bstore@5.0.0
_13
vtex install vtex.b2b-suite@2.0.0

If any of the apps above are not installed in your store, update only the ones you have.

  1. Run the command below to check if there are any dependencies on older versions.

_10
vtex deps list | grep <app-name-without-version>

  1. If there are any apps with an older version, update them as described in step 2.

To revert to a previous version, reinstall the earlier versions of each app.

Updating custom apps with ACL support

If your account uses custom apps that depend on the b2b-organizations-graphql or storefront-permissions apps, you need to update the manifest.json file to include the permission policies.

The manifest.json file is located at the root of the app repository. Open the file in a code editor and add the following policies in the policies section:


_10
"policies": [
_10
{
_10
"name": "buyer_organization_view"
_10
},
_10
{
_10
"name": "buyer_organization_edit"
_10
}
_10
]

After saving the file, publish the app again to apply the changes.

Contributors
1
Photo of the contributor
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
1
Photo of the contributor
Was this helpful?
Suggest edits (GitHub)
On this page