API de Usuarios
Administre usuarios en toda la plataforma mindzieStudio. Cree, actualice y asigne usuarios a tenants con alcances de API flexibles.
Características
Operaciones Globales
Gestión de usuarios a nivel de sistema con una Clave API Global. Liste todos los usuarios, cree usuarios, actualice propiedades y gestione asignaciones de tenants en toda la plataforma.
Operaciones de Tenant
Gestión de usuarios con alcance en un tenant que funciona con Claves API Globales o de Tenant. Administre usuarios dentro del contexto de un tenant específico.
Roles y Permisos
Los roles de usuario definen niveles de acceso y capacidades. Comprenda la jerarquía de roles, cuentas de servicio y mejores prácticas para la gestión de accesos.
Alcances de la API
La API de Usuarios tiene dos alcances:
| Alcance | Ruta Base | Clave API Requerida |
|---|---|---|
| Global | /api/user |
Clave API Global |
| Con alcance de Tenant | /api/tenant/{tenantId}/user |
Clave API Global o de Tenant |
Endpoints Disponibles
Endpoints Globales de Usuario
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/user |
Listar todos los usuarios |
| POST | /api/user |
Crear un usuario |
| GET | /api/user/{userId} |
Obtener usuario por ID |
| PUT | /api/user/{userId} |
Actualizar usuario |
| GET | /api/user/by-email/{email} |
Obtener usuario por correo electrónico |
| GET | /api/user/{userId}/tenants |
Obtener tenants del usuario |
Endpoints de Usuario con Alcance de Tenant
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/tenant/{tenantId}/user |
Listar usuarios del tenant |
| POST | /api/tenant/{tenantId}/user |
Crear usuario en tenant |
| GET | /api/tenant/{tenantId}/user/{userId} |
Obtener usuario en tenant |
| PUT | /api/tenant/{tenantId}/user/{userId} |
Actualizar usuario en tenant |
| GET | /api/tenant/{tenantId}/user/by-email/{email} |
Obtener por correo en tenant |
| POST | /api/tenant/{tenantId}/user/{userId} |
Asignar usuario a tenant |
| DELETE | /api/tenant/{tenantId}/user/{userId} |
Remover del tenant |
Roles de Usuario
| Rol (pantalla) | Nombre del rol en API | Nivel | Descripción |
|---|---|---|---|
| Administrador del Servidor | TenantAdmin |
Sistema | Acceso más alto. Alcance completo a todos los tenants y el servidor. |
| Administrador | Administrator |
Tenant | Autoridad administrativa total dentro de un tenant. |
| Administrador TI | ITAdmin |
Tenant | Integraciones, conexiones y claves API globales. |
| Analista | Analyst |
Proyecto | Crear y gestionar análisis, dashboards e investigaciones. |
| Desarrollador | Developer |
Proyecto | Construir integraciones, gestionar acciones y aplicaciones. |
| Usuario | User |
Solo lectura | Ver dashboards y análisis; no puede modificar contenido. |
Consulte Roles y Permisos para la guía completa de roles.
Autenticación
| Alcance del Endpoint | Tipo de Clave API | Acceso |
|---|---|---|
Global (/api/user) |
Clave API Global | Todos los tenants |
| Con alcance de Tenant | Clave API Global | Todos los tenants |
| Con alcance de Tenant | Clave API de Tenant | Solo su tenant |
Consulte Autenticación para detalles sobre tipos de clave API y su uso.
Inicio Rápido
# Listar todos los usuarios (se requiere clave API Global)
curl -X GET "https://your-mindzie-instance.com/api/user" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Listar usuarios en un tenant (funciona clave API de Tenant)
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}/user" \
-H "Authorization: Bearer YOUR_TENANT_API_KEY"
Notas Importantes
- Claves Globales vs de Tenant: Use claves con alcance de tenant para la mayoría de las operaciones; reserve las claves globales para la administración del sistema
- Desactivación de Usuarios: Use
disabled: trueen lugar de eliminar usuarios para preservar registros de auditoría - Cuentas de Servicio: Solo los roles Administrador del Servidor (
TenantAdmin) y Administrador pueden ser cuentas de servicio - Límites de Capacidad: Los tenants tienen límites configurables de usuarios y analistas