v50

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

Add roles to admin user or API Key

Allows you to add License Manager roles to a particular admin user or API key by specifying the list of role IDs on the request body.

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.

put/api/license-manager/users/{userId}/roles

Path parameters

userIdstring required
Example:a404870467d24533a085a6b3c6a5a320

ID of the user.

Request body

integer[] required

Array containing role IDs.

Example request

[
  9000
]

Response

Success - A no-content response, but the roles were added successfully.