users_create
Create new VPN user accounts with customizable settings including expiration dates, traffic limits, and access controls for secure network management.
Instructions
Create a new VPN user in Remnawave
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| username | Yes | Unique username | |
| expireAt | Yes | Expiration date in ISO 8601 format | |
| trafficLimitBytes | No | Traffic limit in bytes (0 = unlimited) | |
| trafficLimitStrategy | No | Traffic reset period | |
| status | No | Initial user status | |
| description | No | User description | |
| tag | No | User tag for grouping | |
| telegramId | No | Telegram user ID | |
| No | User email | ||
| hwidDeviceLimit | No | Max number of HWID devices | |
| activeInternalSquads | No | Array of internal squad UUIDs |
Implementation Reference
- src/tools/users.ts:105-112 (handler)The handler function for 'users_create' which calls the client's createUser method.
async (params) => { try { const result = await client.createUser(params); return toolResult(result); } catch (e) { return toolError(e); } }, - src/tools/users.ts:77-104 (schema)Input validation schema for 'users_create'.
{ username: z.string().describe('Unique username'), expireAt: z.string().describe('Expiration date in ISO 8601 format'), trafficLimitBytes: z .number() .optional() .describe('Traffic limit in bytes (0 = unlimited)'), trafficLimitStrategy: z .enum(['NO_RESET', 'DAY', 'WEEK', 'MONTH']) .optional() .describe('Traffic reset period'), status: z .enum(['ACTIVE', 'DISABLED']) .optional() .describe('Initial user status'), description: z.string().optional().describe('User description'), tag: z.string().optional().describe('User tag for grouping'), telegramId: z.number().optional().describe('Telegram user ID'), email: z.string().optional().describe('User email'), hwidDeviceLimit: z .number() .optional() .describe('Max number of HWID devices'), activeInternalSquads: z .array(z.string()) .optional() .describe('Array of internal squad UUIDs'), }, - src/tools/users.ts:74-76 (registration)Registration of the 'users_create' tool.
server.tool( 'users_create', 'Create a new VPN user in Remnawave',