User Management API

Organization API

The Users API provides user lifecycle management and administration.

Quick Navigation

• Overview
• Base Path
• Authentication
• Users Flow
• Endpoints
• Internal Notes
• Swagger Documentation

Overview

This module provides:

• User creation and management
• Bulk user import
• User search and filtering
• User activity tracking
• Data export (GDPR compliance)
• User merging

Base Path

All user endpoints are prefixed with /api/v1/users

Authentication

All endpoints require authentication:

Authorization: Bearer <access_token>

Users Flow

The User Management API provides comprehensive user lifecycle management. Administrators can create users, perform bulk imports, search and filter users, track activity, export user data for GDPR compliance, and merge duplicate user accounts.

Users Flow Diagram

View Flow Diagram

Users Flow Overview:

This flow diagram illustrates the user lifecycle management workflow. It shows how users are created and managed, how bulk operations work, how user data is exported, and how user accounts are merged.

Key Flow Components:

1. User Creation: Administrators can create user accounts with initial settings
2. User Management: Update user profiles, status, and account settings
3. Bulk Import: Import multiple users from CSV or other formats
4. User Search: Advanced search and filtering capabilities for user discovery
5. Activity Tracking: Monitor user activity and access patterns
6. Data Export: Export user data for GDPR compliance and reporting
7. User Merging: Merge duplicate user accounts while preserving data

Internal Developer Notes:

• User creation can trigger automatic organization and workspace setup
• Bulk import supports various data formats and validation
• Activity tracking provides audit trails for security and compliance
• Data export supports GDPR right-to-access requests
• User merging consolidates duplicate accounts while preserving history

Endpoints

Method	Endpoint	Description
POST	/	Create user
GET	/	List users
GET	/{user_id}	Get user details
PUT	/{user_id}	Update user
PUT	/{user_id}/status	Update user status
POST	/bulk-import	Bulk import users
POST	/search	Search users
POST	/merge	Merge users
GET	/{user_id}/activity	Get user activity
POST	/{user_id}/export	Export user data
DELETE	/{user_id}	Delete user
GET	/me	Get current user profile
PUT	/me	Update current user profile

Internal Notes

• [WARNING] Not implemented - All endpoints have TODO comments
• Endpoint stubs exist with proper schemas
• Implementation needed for user administration features

Swagger Documentation

Interactive API documentation available at: /docs#/users