User Management API

Create and manage users in your tenant.

Create User

POST /api/v1/admin/users

Creates a new user. Users are identified by their externalId, which should be your internal user identifier.

Request Body

{
  "externalId": "user_123",      // Required: Your internal user ID
  "email": "user@example.com",   // Optional
  "name": "John Doe",            // Optional
  "metadata": {                   // Optional
    "source": "signup"
  }
}

Response

{
  "success": true,
  "data": {
    "id": "user_internal_id",
    "tenantId": "tenant_123",
    "externalId": "user_123",
    "email": "user@example.com",
    "name": "John Doe",
    "metadata": { "source": "signup" },
    "createdAt": "2024-01-01T00:00:00Z"
  }
}

Note: Users are automatically created when validating a license if they don't exist. You only need to create users manually if you want to set additional metadata.

Get Users

GET /api/v1/admin/users

Retrieves all users for your tenant, optionally filtered by external ID.

Query Parameters

externalId (optional) - Filter by external ID