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:

Product	Category	Resource
License Manager	Services access control	Find 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.

Changes

Changed in 7 of the 50 revisions of this API.571

Oct 11, 2023fcf61fb140f21See the full diff
- ▲
  added the new required header request parameter Accept
  new-required-request-parameter
Jan 28, 2022ca8bd421f1332See the full diff
- ●
  deleted the path request parameter accountName
  request-parameter-removed
- ●
  deleted the path request parameter environment
  request-parameter-removed
Nov 9, 20217a2ee1e98a2411See the full diff
- ●
  deleted the path request parameter environment
  request-parameter-removed
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Nov 1, 20212a274b31899211See the full diff
- ▲
  added the new path request parameter environment
  new-request-path-parameter
- ●
  deleted the path request parameter environment
  request-parameter-removed
Oct 28, 2021e1d08a8a5e4411See the full diff
- ▲
  added the new path request parameter environment
  new-request-path-parameter
- ●
  deleted the path request parameter environment
  request-parameter-removed
Sep 10, 20208cadf54dc60b11See the full diff
- ▲
  added the new path request parameter environment
  new-request-path-parameter
- ●
  deleted the path request parameter environment
  request-parameter-removed
Jul 28, 2020542cee6d046e11See the full diff
- ▲
  added the new path request parameter environment
  new-request-path-parameter
- ●
  deleted the path request parameter environment
  request-parameter-removed

Full history