User Accounts

User accounts represent your customers in the Iagon Insight system. Each user account:

• Is scoped to your admin key (multi-tenant isolation)
• Can have an external_id to link to your own customer database
• Can have multiple API credentials
• Tracks status (active, suspended, pending) and billing plan
• Aggregates usage across all associated credentials

Endpoints Overview

Method	Endpoint	Description
GET	/v1/admin/users	List all users
POST	/v1/admin/users	Create a user
GET	/v1/admin/users/:id	Get user by ID
GET	/v1/admin/users/by-external-id/:externalId	Get user by external ID
PATCH	/v1/admin/users/:id	Update user
POST	/v1/admin/users/:id/suspend	Suspend user
POST	/v1/admin/users/:id/reactivate	Reactivate user
GET	/v1/admin/users/:id/usage	Get user usage
GET	/v1/admin/users/usage/summary	Get all users usage

User Object

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "admin_key_id": "660e8400-e29b-41d4-a716-446655440001",
  "admin_entity_name": "YourCompany",
  "external_id": "customer_12345",
  "name": "Acme Corp",
  "email": "api@acme.com",
  "metadata": {
    "tier": "enterprise",
    "region": "us-east"
  },
  "created_at": "2026-01-26T12:00:00Z",
  "updated_at": "2026-01-26T14:30:00Z",
  "status": "active",
  "billing_plan": "pro"
}

Fields

Field	Type	Description
id	UUID	Unique identifier
admin_key_id	UUID	Your admin key ID (for reference)
admin_entity_name	string	Your organization name
external_id	string | null	Your customer ID (for linking to your system)
name	string	User/company name
email	string | null	Contact email
metadata	object	Custom key-value data
created_at	ISO 8601	Creation timestamp
updated_at	ISO 8601 | null	Last update timestamp
status	string	active, suspended, or pending
billing_plan	string | null	Your billing plan identifier

Permission Required

All user account endpoints require the manage_users permission.