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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 string |
| roleId | Integer that represents a role, can be looked up on the License Manager UI |
Endpoints 12
User
- GETGet List of Users
/api/license-manager/site/pvt/logins/list/paged?numItems=10&pageNumber=1&sort=name&sortType=ASCReturns a list of registered users. The response is divided in pages. The query parameter numItems defines the number of items in each page, and consequently… - POSTCreate User
/api/license-manager/usersAllows you to create a user by providing an email (mandatory) and name (optional). The email must be in a valid format. The success response will contain the… - GETGet User
/api/license-manager/users/:userIdAllows you to get a user from the database, using the userId as the identifier.
App Keys
- GETGet appKeys from account
/api/vlm/appkeysGets all application keys from an account. - POSTCreate new appkey
/api/vlm/appkeysCreates a new pair of appKey and appToken. - PUTUpdate appkey
/api/vlm/appkeys/:idActivates or deactivates an appKey by its ID.
Roles
- GETGet List of Roles
/api/license-manager/site/pvt/roles/list/paged?numItems=10&pageNumber=1&sort=id&sortType=ASCReturns a list of available roles. The response is divided in pages. The query parameter numItems defines the number of items in each page, and consequently… - GETGet Roles by User/appKey
/api/license-manager/users/:userId/rolesGets roles of a particular user or application key. - PUTPut Roles in User/appKey
/api/license-manager/users/:userId/rolesAllows you to add roles to a particular user or application key by specifying the list of roles' IDs on the request's body. - DELETERemove Role from User/appKey
/api/license-manager/users/:userId/roles/:roleIdAllows you to remove a role from a specific user or application key. This method only allows the removal of one role per request. The role's ID must be…
Store
- GETGet Stores
/api/vlm/account/storesGets the stores and respective hosts of the account
Account
- GETGet information about account
/api/vlm/accountRetrieves information from an account, such as company and sponsor user details, stores, and appTokens. This endpoint only accepts requests from the host list…
API details
- Base URL
https://vtex.localhttps://{accountName}.{environment}.com.br- Authentication
- An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header - Operations
- 12 operations on 10 pathsGET 7PUT 2POST 2DELETE 1
- Main resources
- Roles 4App Keys 3User 3Account 1Store 1
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the License Manager API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the License Manager API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get List of Users” (GET /api/license-manager/site/pvt/logins/list/paged?numItems=10&pageNumber=1&sort=name&sortType=ASC), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 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… It is listed under Other and has 12 endpoints.
Who publishes the License Manager API?
It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.
What is the base URL of the License Manager API?
Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the License Manager API?
It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.
How many endpoints does the License Manager API have?
12 operations on 10 paths (7 GET, 2 PUT, 2 POST, 1 DELETE). The largest groups are Roles, App Keys, User, Account.
Is forking the License Manager API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.