APIHub
Back to Explore

License Manager API

## Welcome! The License Manager API allows you to create users, modify their names and emails, as well as add and remove roles from users. ### ATTRIBUTES |Attribute name | Description | |:------------|--------------| |accountName | Account name in VTEX License Manager | |environment | Environment on which you want to run the query e.g. vtexcommercestable | |userId | Unique user identification stri

Uncategorized
apiKeyHeader
HTTPS
CORS: Unknown
Visit official documentation

Latency

2886ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/api/license-manager/site/pvt/logins/list/paged

Get List of Users

  • Content-Type (header, required) — The media type of the body of the request. Default value for license manager protocol is application/json
  • numItems (query) — Number of items in the returned page
  • pageNumber (query, page) — Which page from the whole list will be returned
  • sort (query) — Chooses the field that the list will be sorted by
  • sortType (query) — Defines the sorting order. `ASC` is used for ascendant order. `DSC` is used for descendant order
GET

/api/license-manager/site/pvt/roles/list/paged

Get List of Roles

  • Content-Type (header, required) — The media type of the body of the request. Default value for license manager protocol is application/json
  • numItems (query) — Number of items in the returned page
  • pageNumber (query, page) — Which page from the whole list will be returned
  • sort (query) — Chooses the field that the list will be sorted by
  • sortType (query) — Defines the sorting order. ASC is used for ascendant order. DSC is used for descendant order
POST

/api/license-manager/users

Create User

GET

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

Get User

  • Content-Type (header, required) — The media type of the body of the request. Default value for license manager protocol is application/json
  • userId (path, required) — ID from queried user.
GET

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

Get Roles by User/appKey

  • Content-Type (header, required) — The media type of the body of the request. Default value for license manager protocol is application/json
  • userId (path, required) — ID corresponding to the user
PUT

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

Put Roles in User/appKey

  • userId (path, required) — ID corresponding to the user
DELETE

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

Remove Role from User/appKey

  • Content-Type (header, required) — The media type of the body of the request. Default value for license manager protocol is application/json
  • userId (path, required) — ID corresponding to the user
  • roleId (path, required) — ID of the role which will be removed from the user
GET

/api/vlm/account

Get information about account

GET

/api/vlm/account/stores

Get Stores

GET

/api/vlm/appkeys

Get appKeys from account

  • Content-Type (header, required) — The media type of the body of the request. Default value for license manager protocol is application/json
POST

/api/vlm/appkeys

Create new appkey

PUT

/api/vlm/appkeys/{id}

Update appkey

  • id (path, required) — ID from the appKey which will be updated

12 endpoints auto-detected

Authentication

This API uses an API key, passed in the "X-VTEX-API-AppKey" header. No OAuth required.

curl -X GET \
  "https://vtex.local/api/license-manager/site/pvt/logins/list/paged" \
  -H "X-VTEX-API-AppKey: YOUR_API_KEY"

vtex.local · HTTPS only