Documentation
Feedback
Guides

Legacy B2B components
Admin Organizations

This is an Admin application for managing Roles and Permissions for organizations on a B2B Store.

Usage

Install the app, then you can see the features in Admin view.

vtex install vtex.admin-organizations@1.x

Prerequisites

In order to run this application, you must create the following Master Data schemas. Use MASTER DATA API - V2 in VTEX API documentation to create those schemas.

These schemas are shared among several applications admin-organizations, organizations-challenge and organizations. Therefore, if you have already created these schemas before, you can ignore this step.

Permissions

Data Entity Name: BusinessPermission Schema Name: business-permission-schema-v1

{ "properties": { "name": { "type": "string" }, "label": { "type": "string" } }, "v-default-fields": [ "name", "label", "id" ], "required": [ "name" ], "v-indexed": [ "name" ], "v-security": { "allowGetAll": true, "publicRead": [ "name", "label", "id" ], "publicWrite": [ "name", "label" ], "publicFilter": [ "name", "id" ] } }
Roles

Data Entity Name: BusinessRole Schema Name: business-role-schema-v1

{ "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "permissions": { "type": "string" } }, "definitions": { "permission": { "type": "string" } }, "v-default-fields": [ "name", "label", "id", "permissions" ], "required": [ "name" ], "v-indexed": [ "name" ], "v-security": { "allowGetAll": true, "publicRead": [ "name", "label", "permissions", "id" ], "publicWrite": [ "name", "label", "permissions" ], "publicFilter": [ "name", "id" ] } }

Add Required roles

You will need to create the Manager role to make other related applications work properly. Use label as Manager and name as manager to create this role.

Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page