canonical: https://jentic.com/apis/vtex.local/license-manager-api

# Vtex License Manager API

The License Manager API allows you to create users, modify their names and emails, add and remove [roles](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) from users, and create and manage [appKeys](https://help.vtex.com/en/tutorial/application-keys--2iffYzlvvz4BDMr6WGUtet). Common parameters |Attribute name | Description | |:------------|--------------| |`accountName` | Account na. The API exposes 13 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get user, delete user. Covers 13 operations with apiKey authentication.

## Scope

Does not handle payments, crm, or developer tools - use for communications only.

## Capabilities

- Get user
- Delete user
- Create user
- Add roles to user or appKey
- Remove role from user or appKey

## Use cases

### Communications Operations

Use the License Manager API to perform communications operations programmatically. The API provides 13 endpoints covering core functionality including get user, delete user, create user.

Example prompt: Call GET `/api/license-manager/users/{userId}` to get user

### Automated Users Management

Automate users operations by combining multiple License Manager API endpoints. Agents can delete user and then create user in a single workflow.

Example prompt: Call DELETE `/api/license-manager/users/{userId}` to delete user, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call License Manager API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get user', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/license-manager/users/{userId}` | Get user |
| DELETE | `/api/license-manager/users/{userId}` | Delete user |
| POST | `/api/license-manager/users` | Create user |
| GET | `/api/license-manager/site/pvt/logins/list/paged` | Get list of users |
| GET | `/api/license-manager/users/{userId}/roles` | Get roles by user or appKey |
| PUT | `/api/license-manager/users/{userId}/roles` | Add roles to user or appKey |
| DELETE | `/api/license-manager/users/{userId}/roles/{roleId}` | Remove role from user or appKey |
| GET | `/api/license-manager/site/pvt/roles/list/paged` | Get list of roles |

## Key resources

- **Users** — Operations related to Users
- **App Keys** — Operations related to App Keys
- **Roles** — Operations related to Roles
- **Stores** — Operations related to Stores
- **Account** — Operations related to Account

## Why Jentic

- **Setup:** Wiring the VTEX License Manager API by hand means pairing an App Key with an App Token in the X-VTEX-API-AppKey and X-VTEX-API-AppToken headers, and templating the {accountName} and {environment} host into every call. Through Jentic you install once, import the License Manager API from the API Directory, store the App Key and App Token once, and your agent calls it.
- **Permission scoping:** The License Manager API puts the user id in the URL path (`/api/license-manager/users/{userId}/roles`), so a rule can pin your agent to one user and the roles under it. You choose the operations it may call, so destructive ones like deleting a user or removing a role are not included unless you add them.
- **Credential handling:** Your VTEX App Key and App Token are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get a license manager user' or 'list roles for a user', and Jentic returns the matching License Manager API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio** — Alternative communications API
- **Sendgrid** — Alternative communications API
- **Pusher** — Complementary communications API

## FAQ

### What authentication does the License Manager API use?

The License Manager API uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get user with the License Manager API?

Yes. Use the GET `/api/license-manager/users/{userId}` endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the License Manager API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get user through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get user'. Jentic returns the matching License Manager API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the License Manager API have?

The License Manager API exposes 13 endpoints covering users, app keys, roles operations.

### Can I limit what my agent is allowed to do with the License Manager API?

Yes. Because you run Jentic One yourself, your own rules decide which License Manager operations and credentials the agent may use. Since the API puts the user id in the URL path, such as `/api/license-manager/users/{userId}/roles`, you can pin the agent to a single user and the roles under it. You also pick the exact operations it can call, so destructive ones like deleting a user (DELETE `/api/license-manager/users/{userId}`) or removing a role are left out unless you explicitly allow them.