v50

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

Get roles by admin user ID or API Key

Retrieves License Manager roles of a particular admin user or API key.

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 controlFind user by email

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing app keys when assigning License Manager roles to integrations.

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

Path parameters

userIdstring required
Example:e845b52a40e24654a2c70766adb5762b

ID of 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

idinteger

ID of role.

namestring

Name of the role.