Storefront Roles API

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.

This feature is available only for stores using B2B Buyer Portal, currently available for select accounts.

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.

Learn more about the available storefront roles and resources at the Storefront Roles guide.

Index

Storefront Roles

• POST Assign one storefront role: Assigns a specific storefront role to an existing user.
• POST Assign storefront roles: Fully updates the user's role list based on the provided role IDs. Creates the user if they do not exist.
• DELETE Revoke storefront roles: Removes the specified storefront roles from a user.
• GET Check storefront user resource access: Verifies if a storefront user has access to a resource.
• DELETE Remove storefront user: Removes a user from the Storefront system.
• GET Get storefront user roles: Retrieves the list of storefront roles assigned to a specific user.
• GET Fetch storefront user roles by email: Retrieves all storefront roles assigned to a user by email.
• GET Fetch storefront user details: Retrieves storefront user details by ID.

Common parameters

Parameter name	Description	Type
X-VTEX-API-AppKey	Unique identifier of the application key.	Authentication header.
X-VTEX-API-AppToken	Secret token of the application key.	Authentication header.
VtexIdclientAutCookie	User token, valid for 24 hours.	Authentication header.