Documentation

App Development

Storefront Development

Troubleshooting

API Reference

Filter By

Post

Get

Put

Delete

Patch

License Manager API

The License Manager API allows you to create users, modify their names and emails, add and remove roles from users, and create and manage API keys.

Common parameters

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 obtained from the `GET` Get list of roles endpoint.

Index

User

GET Get admin user information by user ID
DELETE Delete admin user
POST Create admin user
GET Get list of admin users

Roles

PUT Add roles to admin user or API Key
GET Get roles by admin user ID or API Key
DELETE Remove role from admin user or API Key
GET Get list of roles

API keys

Store

GET Get stores

Account

GET Get information about account

Endpoints

Users

Summary	Method	Path
Get admin user information by user ID	GET	`/api/license-manager/users/{userId}`
Delete admin user	DELETE	`/api/license-manager/users/{userId}`
Create admin user	POST	`/api/license-manager/users`
Get list of admin users	GET	`/api/license-manager/site/pvt/logins/list/paged`

API keys

Summary	Method	Path
Create new API Key	POST	`/api/vlm/appkeys`
Get API keys from account	GET	`/api/vlm/appkeys`
Update API Key	PUT	`/api/vlm/appkeys/{id}`

Roles

Summary	Method	Path
Add roles to admin user or API Key	PUT	`/api/license-manager/users/{userId}/roles`
Get roles by admin user ID or API Key	GET	`/api/license-manager/users/{userId}/roles`
Remove role from admin user or API Key	DELETE	`/api/license-manager/users/{userId}/roles/{roleId}`
Get list of roles	GET	`/api/license-manager/site/pvt/roles/list/paged`

Stores

Summary	Method	Path
Get stores	GET	`/api/vlm/account/stores`

Account

Summary	Method	Path
Get information about account	GET	`/api/vlm/account`

Loading API specification...