Storefront Permissions UI

All ContributorsAll Contributors

Storefront Permissions UI provides an interface for the Storefront Permissions app, which is part of VTEX’s B2B Suite solution, a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships.

B2B customers often play distinct roles within their organization, such as professional buyer, manager, or supervisor. Each role is associated with a different set of permissions, depending on the actions the user needs to perform.

This app communicates with the backstage Storefront Permissions app and provides the following features for this scenario:

  • Roles management: allow VTEX Admin users to manage B2B roles and associated app permissions through an interface.
  • Theme blocks configuration: enable conditional theme blocks so that only users with the required permissions can access determined parts of the content in your storefront.

We recommend that you use it alongside the other apps in the B2B Suite for all functionalities to work as expected.

Before you start

Make sure you have the VTEX IO CLI (Command Line Interface) installed in your machine.

Installation

You can install the app by running vtex install vtex.storefront-permissions-ui in your terminal, using the VTEX IO CLI.

After this command, the app will be installed in your VTEX Admin, and you can access it on Account Settings > Storefront Permissions.

Installing Storefront Permissions UI has the effect of automatically installing the Storefront Permissions app as a dependency, in case it is not already installed.

Roles management

To manage roles and their respective app permissions using the Storefront Permissions UI, follow the steps below after installing the app.

  1. At the VTEX Admin, navigate to Account Settings > Storefront Permissions.

  2. Click on one of the available storefront roles.

  3. Click on one of the listed apps.

    Only apps that are integrated with Storefront Permissions will be on the list – check our Storefront Permissions documentation for more information.

  4. Select which permissions you want to enable for the role, as illustrated below.

  5. Once you are done, click on Save.

storefront-permissions-uistorefront-permissions-ui

After associating roles with the desired permissions, you may then assign roles to users. To learn more about this, read our B2B Organizations documentation.

Available storefront roles

In the following table, you can see the available storefront roles, their key used for identification in the app’s code, and their description.

RoleKeyDescription
Store Adminstore-adminStore administrator, that is, a user who has access to the VTEX Admin.
Sales Adminsales-adminSales administrator user who can manage all sales users.
Sales Managersales-managerSales manager user who can manage sales users in the same organization, as well as assist or impersonate buyers during navigation or purchase.
Sales Representativesales-representativeSales representative user who can assist or impersonate buyers in the same cost center during navigation or purchase.
Organization Admincustomer-adminMain organization user who manages the organization information, as well as its members and cost centers.
Organization Approvercustomer-approverOrganization user who can take a saved cart or quote that was created by an Organization Buyer and use it to place an order.
Organization Buyercustomer-buyerOrganization user who has the ability to add items to cart. If the B2B Quotes app is installed, they are also able to save their cart for future use or create a quote.

Theme blocks configuration

If you only want users with roles that have the required permissions to be able to access determined parts of the content in your storefront, you can also configure conditional blocks in your store’s theme. These types of blocks allow you to validate information in order to display or hide content in your storefront.

In case you need more information on how to start building your own theme, read our documentation before you proceed.

If you are experienced in developing and customizing your store’s theme, follow the steps below to declare the conditional blocks enabled by Storefront Permissions UI.

  1. Open your store theme app’s repository in your local files.

  2. In the manifest.json file, under dependencies, add "vtex.storefront-permissions-ui": "1.x", like in the example below.

     "dependencies": {
       "vtex.storefront-permissions-ui": "1.x"
      },
    
  3. Now, you can use the check-permission, allowed-content and disallowed-content blocks on any files you want in your store’s theme. See more information on these blocks below.

    Block nameDescription
    check-permissionChecks if the current user has the required permissions to access the content wrapped with this block.
    You can wrap content blocks with check-permission when declaring them to validate if the user has the required permissions to see that content. Example: check-permission#carousel
    allowed-contentAllows you to define on children blocks the content that will be shown for allowed users – users with roles that have the required permissions to view the block.
    disallowed-contentOptional block that allows you to define on children blocks the content that will be shown for disallowed users – users with roles that do not have the required permissions to view the block.

    This component will check if the user has permission to see the allowed-content, otherwise they will see the disallowed-content.

    The check-permission block has a prop named roles, which lets you define an array of roles that are allowed to see the blocks defined under the children blocks of allowed-content.

    Prop nameTypeDescriptionRequiredExample
    rolesarray of stringsList of the allowed roles, identified by their key. Learn more about each role and its key in the Available storefront roles section.true["store-admin", "sales-admin"]

Example

In the example below, in a store’s home, a carousel with banners will only be visible to logged in users with the store-admin or sales-admin roles. Users with other roles will see a warning message (**You don't have access to this content**) instead.

{
  "store.home": {
    "blocks": [
+     "check-permission#carousel",
      "shelf#home",
      "info-card#home",
      "rich-text#question",
      "rich-text#link"
    ]
  },
+  "check-permission#carousel": {
+    "props": {
+      "roles": ["store-admin", "sales-admin"]
+    },
+    "blocks": ["allowed-content#carousel","disallowed-content#carousel"]
+  },
+  "allowed-content#carousel": {
+    "children": ["carousel#home"]
+  },
+  "disallowed-content#carousel": {
+    "children": ["rich-text#disallowed"]
+  },
+  "rich-text#disallowed": {
+    "props": {
+      "text": "**You don't have access to this content**"
+    }
+  },
  "carousel#home": {
    "props": {
      "autoPlay": false,
      "banners": [
        {
          "image": "https://storecomponents.vteximg.com.br/arquivos/banner-principal.png",
          "mobileImage": "https://storecomponents.vteximg.com.br/arquivos/banner-principal-mobile.jpg"
        },
        {
          "image": "https://storecomponents.vteximg.com.br/arquivos/banner.jpg",
          "mobileImage": "https://storecomponents.vteximg.com.br/arquivos/banner-principal-mobile.jpg"
        }
      ],
      "height": 720,
      "showArrows": true,
      "showDots": true
    }
  },

What’s Next
Did this page help you?