{ "openapi": "3.0.0", "info": { "version": "1.0", "title": "Storefront Roles API", "description": "The Storefront Roles API allows you to manage user roles and resource access within the VTEX License Manager for storefront users. You can assign storefront roles to existing users, or create new users with assigned roles in a single request. The API also allows you to revoke storefront roles, check user access to resources, remove users, and fetch user roles and details.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n>⚠️ All endpoints require the Storefront Roles feature to be enabled for your account. Requests to accounts without this feature enabled will receive a 403 Forbidden response.\r\n\r\n>ℹ️ Learn more about the available storefront roles and resources at the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide.\r\n\r\n## Common parameters\r\n\r\n| Parameter name | Description | Type |\r\n| - | - | - |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys). | Authentication header. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. |" }, "servers": [ { "url": "https://{accountName}.{environment}.com.br", "description": "VTEX server URL.", "variables": { "accountName": { "description": "Name of the VTEX account. Used as part of the URL.", "default": "apiexamples" }, "environment": { "description": "Environment to use. Used as part of the URL.", "enum": [ "vtexcommercestable" ], "default": "vtexcommercestable" } } } ], "paths": { "/api/license-manager/storefront/roles/assign": { "post": { "tags": [ "Storefront Roles" ], "summary": "Assign one storefront role", "description": "Assigns a specific storefront role to an existing user.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n>ℹ️ Learn more about the available storefront roles and resources at the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Edit Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "roleId", "userId" ], "properties": { "roleId": { "type": "integer", "description": "Storefront role ID to assign. Check the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide for the full list of roles." }, "userId": { "type": "string", "format": "uuid", "description": "GUID of the user to assign the storefront role to." } } }, "example": { "roleId": 123, "userId": "00000000-0000-0000-0000-000000000000" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "description": "Boolean indicating if the storefront role was successfully assigned." }, "example": true } } }, "400": { "description": "Bad Request\n\nMissing or invalid request parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "examples": { "missingRoleId": { "summary": "Missing role ID", "value": { "error": "MISSING_ROLE_ID", "description": "Role ID is required" } }, "invalidUserId": { "summary": "Invalid user ID", "value": { "error": "INVALID_USER_ID", "description": "User ID must be a valid GUID" } } } } } }, "401": { "description": "Unauthorized\n\nInvalid authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "UNAUTHORIZED", "description": "Authentication required" } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "FORBIDDEN_OPERATION", "description": "Operation not allowed" } } } }, "404": { "description": "Not Found\n\nUser not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "USER_NOT_FOUND", "description": "User not found in the system" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INTERNAL_ERROR", "description": "An internal error occurred" } } } } } } }, "/api/license-manager/storefront/user/roles": { "delete": { "tags": [ "Storefront Roles" ], "summary": "Revoke storefront role from user", "description": "Removes the specified storefront roles from a user. The endpoint ignores role IDs that do not exist or are not assigned to the user. Returns the resulting role list after removal.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n>ℹ️ Learn more about the available storefront roles and resources at the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Edit Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Storefront user information.", "required": [ "id", "roleIds" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "GUID of the storefront user." }, "roleIds": { "type": "array", "description": "List of storefront role IDs to revoke from the user. Role IDs that do not exist or are not assigned to the user will be ignored. Check the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide for the full list of roles.", "items": { "type": "integer", "description": "Storefront role ID to revoke from the user." } } } }, "example": { "id": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f332", "roleIds": [ 3 ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "User GUID." }, "roles": { "type": "array", "description": "List of roles assigned to the user after revocation.", "items": { "type": "object", "description": "Role information.", "properties": { "id": { "type": "integer", "description": "Role ID." }, "name": { "type": "string", "description": "Role name." } } } } } }, "example": { "id": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f332", "roles": [ { "id": 1, "name": "Organizational Unit Admin" }, { "id": 2, "name": "Order Approver" } ] } } } }, "400": { "description": "Bad Request\n\nMissing or invalid request parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "examples": { "missingRoleId": { "summary": "Missing role ID", "value": { "error": "MISSING_ROLE_ID", "description": "Role ID is required" } }, "roleNotAssigned": { "summary": "Role not assigned", "value": { "error": "ROLE_NOT_ASSIGNED", "description": "User does not have this role assigned" } } } } } }, "401": { "description": "Unauthorized\n\nInvalid authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "UNAUTHORIZED", "description": "Authentication required" } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "FORBIDDEN_OPERATION", "description": "Operation not allowed" } } } }, "404": { "description": "Not Found\n\nUser not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "USER_NOT_FOUND", "description": "User not found in the system" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INTERNAL_ERROR", "description": "An internal error occurred" } } } } } }, "post": { "tags": [ "Storefront Roles" ], "summary": "Assign storefront roles or create user with storefront roles", "description": "Fully updates the user's role list based on the `roleIds` provided. This endpoint replaces all existing roles with the specified ones. If the user does not exist, this endpoint creates the user and assigns the indicated roles.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n>ℹ️ Learn more about the available storefront roles and resources at the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Edit Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "description": "Storefront user information.", "required": [ "id", "roleIds" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "GUID of the storefront user to create." }, "roleIds": { "type": "array", "description": "List of storefront role IDs to assign to the user. Check the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide for the full list of roles.", "items": { "type": "integer", "description": "Storefront role ID to assign to the user." } } } }, "example": { "id": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f332", "roleIds": [ 1, 4, 5 ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "User GUID." }, "roles": { "type": "array", "description": "List of roles assigned to the user.", "items": { "type": "object", "description": "Role information.", "properties": { "id": { "type": "integer", "description": "Role ID." }, "name": { "type": "string", "description": "Role name." } } } } } }, "example": { "id": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f332", "roles": [ { "id": 1, "name": "Organizational Unit Admin" }, { "id": 4, "name": "Buyer" }, { "id": 5, "name": "Personal Cards User" } ] } } } }, "400": { "description": "Bad Request\n\nMissing or invalid request parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "examples": { "missingId": { "summary": "Missing ID", "value": { "error": "MISSING_ID", "description": "User ID is required" } }, "invalidRoles": { "summary": "Invalid roles", "value": { "error": "INVALID_ROLES", "description": "At least one valid role must be provided" } } } } } }, "401": { "description": "Unauthorized\n\nInvalid authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "UNAUTHORIZED", "description": "Authentication required" } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "FORBIDDEN_OPERATION", "description": "Operation not allowed" } } } }, "404": { "description": "Not Found\n\nUser not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "USER_NOT_FOUND", "description": "User not found in the system" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INTERNAL_ERROR", "description": "An internal error occurred" } } } } } } }, "/api/license-manager/storefront/users/{userId}/resources/{resourceKey}/granted": { "get": { "tags": [ "Storefront Roles" ], "summary": "Check storefront user resource access", "description": "Verifies if a specific storefront user has access to a particular storefront resource.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n>ℹ️ Learn more about the available storefront roles and resources at the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **View Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string", "example": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f332" }, "required": true, "description": "GUID of the user to check." }, { "name": "resourceKey", "in": "path", "schema": { "type": "string", "example": "PlaceOrders" }, "required": true, "description": "Storefront resource key. Check the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide for the full list of resources." }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean", "description": "Boolean indicating if the user has access to the resource." }, "example": true } } }, "400": { "description": "Bad Request\n\nMissing or invalid request parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "examples": { "invalidResourceKey": { "summary": "Invalid resource key", "value": { "error": "INVALID_RESOURCE_KEY", "description": "Resource key is not valid" } }, "invalidUserId": { "summary": "Invalid user ID", "value": { "error": "INVALID_USER_ID", "description": "User ID must be a valid GUID or email" } } } } } }, "401": { "description": "Unauthorized\n\nInvalid authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "UNAUTHORIZED", "description": "Authentication required" } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "FORBIDDEN_OPERATION", "description": "Operation not allowed" } } } }, "404": { "description": "Not Found\n\nUser not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "USER_NOT_FOUND", "description": "User not found in the system" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INTERNAL_ERROR", "description": "An internal error occurred" } } } } } } }, "/api/license-manager/storefront/remove/users/{userId}": { "delete": { "tags": [ "Storefront Roles" ], "summary": "Remove storefront user", "description": "Removes a storefront user from the system, including all their storefront role assignments.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n>ℹ️ Learn more about the available storefront roles and resources at the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Edit Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string", "example": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f33" }, "required": true, "description": "GUID of the user to remove." }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "200": { "description": "OK\n\nBoolean indicating if the user was successfully removed.", "content": { "application/json": { "schema": { "type": "boolean" }, "example": true } } }, "400": { "description": "Bad Request\n\nMissing or invalid request parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INVALID_USER_ID", "description": "User ID must be a valid GUID" } } } }, "401": { "description": "Unauthorized\n\nInvalid authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "UNAUTHORIZED", "description": "Authentication required" } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "FORBIDDEN_OPERATION", "description": "Operation not allowed" } } } }, "404": { "description": "Not Found\n\nUser not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "USER_NOT_FOUND", "description": "User not found in the system" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INTERNAL_ERROR", "description": "An internal error occurred" } } } } } } }, "/api/license-manager/storefront/users/{userId}/roles": { "get": { "tags": [ "Storefront Roles" ], "summary": "Fetch storefront user roles by ID", "description": "Retrieves all storefront roles assigned to a specific user by user ID.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n>ℹ️ Learn more about the available storefront roles and resources at the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **View Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string", "format": "uuid", "example": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f332" }, "required": true, "description": "GUID of the user to retrieve roles for." }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "description": "User GUID." }, "identifier": { "type": "string", "description": "User identifier (typically email address)." }, "roles": { "type": "array", "description": "List of roles assigned to the user.", "items": { "type": "object", "description": "Role information.", "properties": { "id": { "type": "integer", "description": "Role ID." }, "name": { "type": "string", "description": "Role name." } } } } } }, "example": { "userId": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f332", "identifier": "user@example.com", "roles": [ { "id": 1, "name": "Organizational Unit Admin" }, { "id": 2, "name": "Order Approver" } ] } } } }, "400": { "description": "Bad Request\n\nMissing or invalid request parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INVALID_USER_ID", "description": "User ID must be a valid GUID" } } } }, "401": { "description": "Unauthorized\n\nInvalid authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "UNAUTHORIZED", "description": "Authentication required" } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "FORBIDDEN_OPERATION", "description": "Operation not allowed" } } } }, "404": { "description": "Not Found\n\nUser not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "USER_NOT_FOUND", "description": "User not found in the system" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INTERNAL_ERROR", "description": "An internal error occurred" } } } } } } }, "/api/license-manager/storefront/users/{email}/roles": { "get": { "tags": [ "Storefront Roles" ], "summary": "Fetch storefront user roles by email", "description": "Retrieves all storefront roles assigned to a specific user by email.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n>ℹ️ Learn more about the available storefront roles and resources at the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **View Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "name": "email", "in": "path", "schema": { "type": "string", "example": "lekas53942@hazhab.com" }, "required": true, "description": "Email address of the user to retrieve roles for." }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "200": { "description": "OK \n\n User roles response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid", "description": "User GUID." }, "email": { "type": "string", "description": "User email address." }, "roles": { "type": "array", "items": { "type": "string", "description": "Storefront role name." }, "description": "List of storefront role names assigned to the user. Check the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide for the full list of roles." } } }, "example": { "UserId": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f332", "Email": "lekas53942@hazhab.com", "Roles": [ "Organizational Unit Admin" ] } } } }, "400": { "description": "Bad Request\n\nMissing or invalid request parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INVALID_EMAIL", "description": "Email address is not valid" } } } }, "401": { "description": "Unauthorized\n\nInvalid authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "UNAUTHORIZED", "description": "Authentication required" } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "FORBIDDEN_OPERATION", "description": "Operation not allowed" } } } }, "404": { "description": "Not Found\n\nUser not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "USER_NOT_FOUND", "description": "User not found in the system" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INTERNAL_ERROR", "description": "An internal error occurred" } } } } } } }, "/api/license-manager/storefront/users/{userId}": { "get": { "tags": [ "Storefront Roles" ], "summary": "Fetch storefront user details", "description": "Retrieves storefront user details by ID.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **View Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "name": "userId", "in": "path", "schema": { "type": "string", "example": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f33" }, "required": true, "description": "GUID of the user to retrieve." }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "200": { "description": "OK \n\n User details response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "description": "User email address." } } }, "example": { "email": "lekas53942@hazhab.com" } } } }, "400": { "description": "Bad Request\n\nMissing or invalid request parameters.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INVALID_USER_ID", "description": "User ID must be a valid GUID" } } } }, "401": { "description": "Unauthorized\n\nInvalid authentication.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "UNAUTHORIZED", "description": "Authentication required" } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "FORBIDDEN_OPERATION", "description": "Operation not allowed" } } } }, "404": { "description": "Not Found\n\nUser not found.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "USER_NOT_FOUND", "description": "User not found in the system" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "Error code." }, "description": { "type": "string", "description": "Error description." } } }, "example": { "error": "INTERNAL_ERROR", "description": "An internal error occurred" } } } } } } }, "/api/license-manager/storefront/role": { "get": { "tags": [ "Custom Storefront Roles" ], "summary": "List storefront roles", "description": "Returns all storefront roles visible to the account, including native VTEX roles and the account's own custom roles. An empty array is a valid response.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **View Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/accountName" }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "List of all roles visible to the account.", "items": { "type": "object", "description": "Role information.", "properties": { "Id": { "type": "integer", "description": "Role identifier." }, "Name": { "type": "string", "description": "Role name." }, "IsCustom": { "type": "boolean", "description": "Set to `true` for account-defined roles or `false` for native VTEX roles." }, "Resources": { "type": "array", "description": "Resources assigned to the role.", "items": { "type": "object", "description": "Resource information.", "properties": { "Id": { "type": "integer", "description": "Resource identifier." }, "Key": { "type": "string", "description": "Stable permission key." }, "IsCustom": { "type": "boolean", "description": "Set to `true` when custom or `false` for native." } } } } } } }, "example": [ { "Id": 1, "Name": "Organizational Unit Admin", "IsCustom": false, "Resources": [ { "Id": 1, "Key": "ManageOrganizationAndContract", "IsCustom": false } ] }, { "Id": 42, "Name": "Report Viewer", "IsCustom": true, "Resources": [ { "Id": 1, "Key": "ManageOrganizationAndContract", "IsCustom": false }, { "Id": 7, "Key": "MyResource", "IsCustom": true } ] } ] } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account or insufficient permissions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string", "description": "Error message." } } }, "example": { "Message": "Operation not allowed" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "INTERNAL_ERROR", "Message": "An internal error occurred" } } } } } }, "post": { "tags": [ "Custom Storefront Roles" ], "summary": "Create storefront role", "description": "Creates a new account-scoped custom role with the specified name and resource assignments.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Edit Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/accountName" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "Name", "Resources" ], "properties": { "Name": { "type": "string", "description": "Role name. Must be 1–100 characters, unique within the account, and must not match any native VTEX role name. See the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide for a list of native role names." }, "Resources": { "type": "array", "description": "List of resource IDs to assign to the role. Must contain at least one ID. Refer to the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide for a list of available resource IDs.", "items": { "type": "integer", "description": "Resource identifier." } } } }, "example": { "Name": "Report Viewer", "Resources": [1, 7] } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "description": "Newly created role.", "properties": { "Id": { "type": "integer", "description": "Role identifier." }, "Name": { "type": "string", "description": "Role name." }, "Resources": { "type": "array", "description": "Resources assigned to the role.", "items": { "type": "object", "description": "Resource information.", "properties": { "Id": { "type": "integer", "description": "Resource identifier." }, "Key": { "type": "string", "description": "Stable permission key." }, "IsCustom": { "type": "boolean", "description": "Set to `true` when custom or `false` for native." } } } } } }, "example": { "Id": 42, "Name": "Report Viewer", "Resources": [ { "Id": 1, "Key": "ManageOrganizationAndContract", "IsCustom": false }, { "Id": 7, "Key": "MyResource", "IsCustom": true } ] } } } }, "400": { "description": "Bad Request\n\nInvalid request body.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "examples": { "invalidRoleName": { "summary": "Invalid role name", "value": { "Code": "INVALID_ROLE_NAME", "Message": "Name is empty or over 100 characters" } }, "invalidResources": { "summary": "Invalid resources", "value": { "Code": "INVALID_RESOURCES", "Message": "Resource IDs are invalid or not available to this account" } }, "roleMustHaveResources": { "summary": "No resources provided", "value": { "Code": "ROLE_MUST_HAVE_RESOURCES", "Message": "Role must have at least one resource" } } } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account or insufficient permissions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code. Present only for structured errors such as `CANNOT_MODIFY`." }, "Message": { "type": "string", "description": "Error message." } } }, "examples": { "authError": { "summary": "Feature not enabled or insufficient permission", "value": { "Message": "Operation not allowed" } }, "cannotModify": { "summary": "Name matches a native VTEX role", "value": { "Code": "CANNOT_MODIFY", "Message": "Cannot create or modify native VTEX roles" } } } } } }, "409": { "description": "Conflict\n\nA role with the same name already exists in the account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "DUPLICATE_NAME", "Message": "A role with this name already exists" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "INTERNAL_ERROR", "Message": "An internal error occurred" } } } } } } }, "/api/license-manager/storefront/role/{roleId}": { "get": { "tags": [ "Custom Storefront Roles" ], "summary": "Fetch storefront role by ID", "description": "Retrieves a single role by its identifier.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **View Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "name": "roleId", "in": "path", "required": true, "description": "Numeric identifier of the role to retrieve.", "schema": { "type": "integer", "example": 42 } }, { "$ref": "#/components/parameters/accountName" }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "Role information.", "properties": { "Id": { "type": "integer", "description": "Role identifier." }, "Name": { "type": "string", "description": "Role name." }, "IsCustom": { "type": "boolean", "description": "Set to `true` for account-defined roles or `false` for native VTEX roles." }, "Resources": { "type": "array", "description": "Resources assigned to the role.", "items": { "type": "object", "description": "Resource information.", "properties": { "Id": { "type": "integer", "description": "Resource identifier." }, "Key": { "type": "string", "description": "Stable permission key." }, "IsCustom": { "type": "boolean", "description": "Set to `true` when custom or `false` for native." } } } } } }, "example": { "Id": 42, "Name": "Report Viewer", "IsCustom": true, "Resources": [ { "Id": 1, "Key": "ManageOrganizationAndContract", "IsCustom": false } ] } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account or insufficient permissions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string", "description": "Error message." } } }, "example": { "Message": "Operation not allowed" } } } }, "404": { "description": "Not Found\n\nRole does not exist or is not available to this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "ROLE_NOT_FOUND", "Message": "The role was not found" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "INTERNAL_ERROR", "Message": "An internal error occurred" } } } } } }, "put": { "tags": [ "Custom Storefront Roles" ], "summary": "Edit storefront role resources", "description": "Replaces the full resource list of an existing custom role. Send all resources you want the role to have after the update.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Edit Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "name": "roleId", "in": "path", "required": true, "description": "Numeric identifier of the role to update.", "schema": { "type": "integer", "example": 42 } }, { "$ref": "#/components/parameters/accountName" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "Resources" ], "properties": { "Resources": { "type": "array", "description": "Complete list of resource IDs the role should have after the update. Must contain at least one ID. Refer to the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide for a list of available resource IDs.", "items": { "type": "integer", "description": "Resource identifier." } } } }, "example": { "Resources": [1, 9] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "description": "Updated role.", "properties": { "Id": { "type": "integer", "description": "Role identifier." }, "Name": { "type": "string", "description": "Role name." }, "Resources": { "type": "array", "description": "Updated list of resources assigned to the role.", "items": { "type": "object", "description": "Resource information.", "properties": { "Id": { "type": "integer", "description": "Resource identifier." }, "Key": { "type": "string", "description": "Stable permission key." }, "IsCustom": { "type": "boolean", "description": "Set to `true` when custom or `false` for native." } } } } } }, "example": { "Id": 42, "Name": "Report Viewer", "Resources": [ { "Id": 1, "Key": "ManageOrganizationAndContract", "IsCustom": false }, { "Id": 9, "Key": "AnotherResource", "IsCustom": true } ] } } } }, "400": { "description": "Bad Request\n\nInvalid request body.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "examples": { "invalidResources": { "summary": "Invalid resources", "value": { "Code": "INVALID_RESOURCES", "Message": "Resource IDs are invalid or not available to this account" } }, "roleMustHaveResources": { "summary": "No resources provided", "value": { "Code": "ROLE_MUST_HAVE_RESOURCES", "Message": "Role must have at least one resource" } } } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account or insufficient permissions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code. Present only for structured errors such as `CANNOT_MODIFY`." }, "Message": { "type": "string", "description": "Error message." } } }, "examples": { "authError": { "summary": "Feature not enabled or insufficient permission", "value": { "Message": "Operation not allowed" } }, "cannotModify": { "summary": "Attempt to modify a native VTEX role", "value": { "Code": "CANNOT_MODIFY", "Message": "Cannot modify native VTEX roles" } } } } } }, "404": { "description": "Not Found\n\nRole does not exist or is not available to this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "ROLE_NOT_FOUND", "Message": "The role was not found" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "INTERNAL_ERROR", "Message": "An internal error occurred" } } } } } }, "delete": { "tags": [ "Custom Storefront Roles" ], "summary": "Delete storefront role", "description": "Permanently removes a custom role from the account. The role must be unassigned from all users before it can be deleted. Native VTEX roles cannot be deleted.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Edit Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "name": "roleId", "in": "path", "required": true, "description": "Numeric identifier of the role to delete.", "schema": { "type": "integer", "example": 42 } }, { "$ref": "#/components/parameters/accountName" }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "204": { "description": "No Content\n\nRole successfully deleted." }, "403": { "description": "Forbidden\n\nFeature not enabled for this account or insufficient permissions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code. Present only for structured errors such as `CANNOT_MODIFY`." }, "Message": { "type": "string", "description": "Error message." } } }, "examples": { "authError": { "summary": "Feature not enabled or insufficient permission", "value": { "Message": "Operation not allowed" } }, "cannotModify": { "summary": "Attempt to delete a native VTEX role", "value": { "Code": "CANNOT_MODIFY", "Message": "Cannot delete native VTEX roles" } } } } } }, "404": { "description": "Not Found\n\nRole does not exist or is not available to this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "ROLE_NOT_FOUND", "Message": "The role was not found" } } } }, "409": { "description": "Conflict\n\nRole has active user assignments and cannot be deleted.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "ROLE_HAS_USERS", "Message": "Role has active user assignments" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "INTERNAL_ERROR", "Message": "An internal error occurred" } } } } } } }, "/api/license-manager/storefront/resource": { "get": { "tags": [ "Custom Storefront Resources" ], "summary": "List storefront resources", "description": "Returns every storefront resource visible to the account, including native VTEX resources and the account's own custom resources.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **View Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/accountName" }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "description": "List of all resources visible to the account.", "items": { "type": "object", "description": "Resource information.", "properties": { "Id": { "type": "integer", "description": "Resource identifier. Use this value when building custom roles." }, "Key": { "type": "string", "description": "Stable permission key checked at runtime." }, "Name": { "type": "string", "nullable": true, "description": "Human-readable label. May be `null` for native resources." }, "Description": { "type": "string", "nullable": true, "description": "Optional description." }, "IsCustom": { "type": "boolean", "description": "Set to `true` when the resource belongs to the account or `false` for native VTEX resources." } } } }, "example": [ { "Id": 1, "Key": "ViewUsers", "Name": "View Users", "Description": null, "IsCustom": false }, { "Id": 42, "Key": "report_viewer", "Name": "Report Viewer", "Description": "Allows access to reporting", "IsCustom": true } ] } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account or insufficient permissions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string", "description": "Error message." } } }, "example": { "Message": "Operation not allowed" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "INTERNAL_ERROR", "Message": "An internal error occurred" } } } } } }, "post": { "tags": [ "Custom Storefront Resources" ], "summary": "Create custom storefront resource", "description": "Registers a new account-scoped permission resource. Each account may hold at most 10 custom resources.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Edit Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "$ref": "#/components/parameters/accountName" }, { "$ref": "#/components/parameters/Content-Type" }, { "$ref": "#/components/parameters/Accept" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "Key" ], "properties": { "Key": { "type": "string", "description": "Permission key. Must be 5–80 characters, unique within the account, and must not match any native VTEX resource key. Keys are treated as case-insensitive. Immutable after creation. See the [Storefront Roles](https://developers.vtex.com/docs/guides/storefront-roles) guide for a list of native resource keys." }, "Name": { "type": "string", "description": "Human-readable label. Maximum 100 characters." }, "Description": { "type": "string", "description": "Optional description. Maximum 500 characters." } } }, "example": { "Key": "report_viewer", "Name": "Report Viewer", "Description": "Allows access to reporting" } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "description": "Newly created custom resource.", "properties": { "Id": { "type": "integer", "description": "Resource identifier." }, "Key": { "type": "string", "description": "Stable permission key." }, "Name": { "type": "string", "description": "Human-readable label." }, "Description": { "type": "string", "description": "Resource description." } } }, "example": { "Id": 42, "Key": "report_viewer", "Name": "Report Viewer", "Description": "Allows access to reporting" } } } }, "400": { "description": "Bad Request\n\nInvalid request body.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "examples": { "invalidResourceKey": { "summary": "Invalid resource key", "value": { "Code": "INVALID_RESOURCE_KEY", "Message": "Key is missing or outside the 5–80 character range" } }, "invalidResourceName": { "summary": "Invalid resource name", "value": { "Code": "INVALID_RESOURCE_NAME", "Message": "Name exceeds 100 characters" } }, "invalidResourceDescription": { "summary": "Invalid resource description", "value": { "Code": "INVALID_RESOURCE_DESCRIPTION", "Message": "Description exceeds 500 characters" } } } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account or insufficient permissions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code. Present only for structured errors such as `CANNOT_CREATE_NATIVE_RESOURCE`." }, "Message": { "type": "string", "description": "Error message." } } }, "examples": { "authError": { "summary": "Feature not enabled or insufficient permission", "value": { "Message": "Operation not allowed" } }, "cannotCreateNativeResource": { "summary": "Attempt to create a resource under VTEX platform account", "value": { "Code": "CANNOT_CREATE_NATIVE_RESOURCE", "Message": "Cannot create native resources" } } } } } }, "409": { "description": "Conflict\n\nA resource with the same key already exists in the account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "DUPLICATE_RESOURCE_KEY", "Message": "A resource with this key already exists" } } } }, "422": { "description": "Unprocessable Entity\n\nThis account already has the maximum of 10 custom resources.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "RESOURCE_QUOTA_EXCEEDED", "Message": "This account already has the maximum number of custom resources" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "INTERNAL_ERROR", "Message": "An internal error occurred" } } } } } } }, "/api/license-manager/storefront/resource/{id}": { "delete": { "tags": [ "Custom Storefront Resources" ], "summary": "Delete custom storefront resource", "description": "Removes a account-level custom resource. Native VTEX resources cannot be deleted through this endpoint.\r\n\r\n> ⚠️ This feature is available only for stores using [B2B Buyer Portal](https://help.vtex.com/docs/tutorials/b2b-buyer-portal), currently available for select accounts.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise, they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Edit Storefront User Permissions** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Numeric ID of the custom resource to delete.", "schema": { "type": "integer", "example": 42 } }, { "$ref": "#/components/parameters/accountName" }, { "$ref": "#/components/parameters/Accept" } ], "responses": { "204": { "description": "No Content\n\nResource successfully deleted." }, "400": { "description": "Bad Request\n\nResource ID is zero or negative.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "INVALID_ID", "Message": "Resource ID is zero or negative" } } } }, "403": { "description": "Forbidden\n\nFeature not enabled for this account or insufficient permissions.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Message": { "type": "string", "description": "Error message." } } }, "example": { "Message": "Operation not allowed" } } } }, "404": { "description": "Not Found\n\nResource does not exist or is not available to this account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "RESOURCE_NOT_FOUND", "Message": "The resource was not found" } } } }, "409": { "description": "Conflict\n\nResource is assigned to one or more roles and cannot be deleted.", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "RESOURCE_IN_USE", "Message": "Resource is assigned to one or more roles" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "Code": { "type": "string", "description": "Error code." }, "Message": { "type": "string", "description": "Error message." } } }, "example": { "Code": "INTERNAL_ERROR", "Message": "An internal error occurred" } } } } } } } }, "security": [ { "appKey": [], "appToken": [] }, { "VtexIdclientAutCookie": [] } ], "components": { "securitySchemes": { "appKey": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppKey", "description": "Unique identifier of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, "appToken": { "type": "apiKey", "in": "header", "name": "X-VTEX-API-AppToken", "description": "Secret token of the [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys)." }, "VtexIdclientAutCookie": { "type": "apiKey", "in": "header", "name": "VtexIdclientAutCookie", "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours." } }, "parameters": { "Content-Type": { "name": "Content-Type", "in": "header", "description": "Type of the content being sent.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } }, "accountName": { "name": "an", "in": "query", "description": "VTEX account name.", "required": true, "style": "form", "schema": { "type": "string", "example": "apiexamples" } }, "Accept": { "name": "Accept", "in": "header", "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.", "required": true, "style": "simple", "schema": { "type": "string", "example": "application/json" } } } }, "tags": [ { "name": "Storefront Roles" }, { "name": "Custom Storefront Roles" }, { "name": "Custom Storefront Resources" } ] }