v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-291317322.2 KB
Roles

Remove role from admin user or API Key

Allows you to remove a License Manager role from a specific admin user or API key. This method only allows the removal of one role per request. The role's ID must be specified on the request path, not on the request body.

Note that a successful response returns a 204 response with an empty body. A deletion on a role or user that does not exist will also return a 204. Thus, this method should not be used to verify the existence of a specific user or role.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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:

ProductCategoryResource
License ManagerServices access controlSave user

You can create a custom role with that resource or use one of the following predefined roles:

RoleResource
User Administrator - RESTRICTEDSave user

❗ Assigning a predefined role to users or application keys usually grants permission to multiple License Manager resources. If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see Best practices for using application keys.

To learn more about machine authentication at VTEX, see Authentication overview.

delete/api/license-manager/users/{userId}/roles/{roleId}

Path parameters

userIdstring required
Example:e845b52a40e24654a2c70766adb5762b

ID of the user.

roleIdstring required
Example:1

ID of the role which will be removed from the user.

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

Success - A no-content response, but the role deletion was performed successfully.