VPN EnterpriseDocs
Documentation›API Reference›User Management

User Management

Manage users, roles, and permissions for your organization

User Management Overview

Comprehensive user management system with role-based access control (RBAC), fine-grained permissions, and organization management.

Roles

OwnerAdminMember

Permissions

Resource-based access control

Security

2FA, Activity logs, Session management

Quick Actions

Invite User

Send invitations to new team members with specific roles and permissions.

POST /users
Manage Permissions

Configure fine-grained permissions for users and resources.

PUT /users/:id/permissions
User Activity

Track user activity, resource usage, and access patterns.

GET /users/:id

User Roles

Owner

Highest Access
Full organization control
Billing and subscription
Delete organization

Admin

Management Access
User management
Resource management
API key management

Member

Standard Access
Own resources only
Limited permissions
Read-only by default

Permission System

Resource-Based Permissions
Fine-grained access control for all VPN Enterprise resources

Available Resources

VPN (connections, servers)
Database (instances, backups)
Hosting (sites, deployments)
Users (management)

Permission Levels

Read: View resources and data
Write: Create and modify resources
Delete: Remove resources
Admin: Full resource control

API Endpoints

GET/users
List all users in your organization (admin only)

Response

{
  "success": true,
  "users": [
    {
      "id": "usr_123",
      "email": "john@company.com",
      "name": "John Doe",
      "role": "member",
      "status": "active",
      "last_login": "2024-12-02T14:20:00Z",
      "created_at": "2024-01-15T10:30:00Z",
      "permissions": ["vpn:read", "database:read"],
      "two_factor_enabled": true
    }
  ],
  "total": 25,
  "page": 1,
  "limit": 20
}
POST/users
Invite a new user to your organization (admin only)

Request Body

{
  "email": "newuser@company.com",
  "name": "New User",
  "role": "member",
  "permissions": ["vpn:read", "database:read"],
  "send_invitation": true
}
GET/users/:id
Get details of a specific user

Response

{
  "success": true,
  "user": {
    "id": "usr_123",
    "email": "john@company.com",
    "name": "John Doe",
    "role": "member",
    "status": "active",
    "last_login": "2024-12-02T14:20:00Z",
    "created_at": "2024-01-15T10:30:00Z",
    "permissions": ["vpn:read", "vpn:write", "database:read"],
    "two_factor_enabled": true,
    "profile": {
      "avatar_url": "https://avatars.vpnenterprise.com/usr_123.jpg",
      "timezone": "America/New_York",
      "language": "en"
    },
    "activity": {
      "vpn_connections": 12,
      "databases_created": 3,
      "api_calls_30d": 1250
    }
  }
}
PUT/users/:id
Update user information and permissions

Request Body

{
  "name": "John Smith",
  "role": "admin",
  "permissions": ["vpn:read", "vpn:write", "database:read", "database:write"],
  "status": "active"
}
DELETE/users/:id
Remove a user from your organization (admin only)

Response

{
  "success": true,
  "message": "User removed from organization",
  "id": "usr_123",
  "email": "john@company.com",
  "resources_transferred_to": "usr_456"
}
GET/users/:id/permissions
Get detailed permissions for a user

Response

{
  "success": true,
  "permissions": {
    "vpn": {
      "read": true,
      "write": true,
      "delete": false
    },
    "database": {
      "read": true,
      "write": true,
      "delete": true
    },
    "hosting": {
      "read": true,
      "write": false,
      "delete": false
    },
    "billing": {
      "read": false,
      "write": false
    }
  }
}
PUT/users/:id/permissions
Update user permissions

Request Body

{
  "permissions": {
    "vpn": {
      "read": true,
      "write": true,
      "delete": true
    },
    "database": {
      "read": true,
      "write": true,
      "delete": false
    }
  }
}

Security Best Practices

Principle of Least Privilege

Grant users only the minimum permissions required for their role. Regularly review and audit user permissions.

Two-Factor Authentication

Enforce 2FA for all users, especially those with administrative privileges. Monitor authentication events.

Regular Access Review

Conduct quarterly access reviews to ensure users have appropriate permissions and remove inactive users.

Next Steps

Learn about billing management and webhook integrations for complete platform control.