API de Inquilinos
Operaciones de gestión de inquilinos a nivel de sistema para mindzieStudio. Crear, listar, actualizar y eliminar inquilinos en toda la plataforma.
IMPORTANTE: Todos los endpoints de la API de inquilinos requieren una Clave Global de API. Las claves de API específicas de inquilinos regulares no pueden acceder a estos endpoints.
Funcionalidades
Gestión
Listar todos los inquilinos, obtener detalles de un inquilino, crear nuevos inquilinos y actualizar la configuración de inquilinos. Configurar límites de usuarios, límites de casos y propiedades del inquilino.
Eliminación
Eliminar inquilinos permanentemente con triple verificación para mayor seguridad. Incluye mejores prácticas para la exportación de datos y flujos de trabajo seguros de eliminación.
Endpoints Disponibles
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /api/tenant |
Listar todos los inquilinos |
| GET | /api/tenant/{tenantId} |
Obtener inquilino por ID |
| POST | /api/tenant |
Crear un inquilino |
| PUT | /api/tenant |
Actualizar un inquilino |
| DELETE | /api/tenant |
Eliminar un inquilino |
Campos del Objeto Tenant
| Campo | Tipo | Descripción |
|---|---|---|
tenantId |
GUID | Identificador único para el inquilino |
name |
string | Nombre único del sistema (usado en URLs) |
displayName |
string | Nombre legible para mostrar |
description |
string | Descripción del inquilino |
caseCount |
integer | Número total de casos |
maxUserCount |
integer | Máximo de usuarios permitidos |
maxAnalystCount |
integer | Máximo de analistas permitidos |
userCount |
integer | Número actual de usuarios |
analystCount |
integer | Número actual de analistas |
isDisabled |
boolean | Indica si el inquilino está deshabilitado |
isAcademic |
boolean | Indica si es un inquilino académico |
preRelease |
boolean | Indica si el inquilino tiene funciones en prerelease |
dateCreated |
datetime | Fecha en que se creó el inquilino |
Autenticación
| Endpoint | Tipo de Clave API | Acceso |
|---|---|---|
Todos los endpoints /api/tenant |
Clave Global de API | Requerida |
| Clave API de Inquilino | 401 No autorizado |
Las claves globales de API pueden crearse a través de la interfaz de administración en /admin/global-api-keys.
Consulte Autenticación para detalles sobre tipos de claves API y uso.
Inicio Rápido
# Listar todos los inquilinos (Clave Global de API requerida)
curl -X GET "https://your-mindzie-instance.com/api/tenant" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
# Obtener un inquilino específico
curl -X GET "https://your-mindzie-instance.com/api/tenant/{tenantId}" \
-H "Authorization: Bearer YOUR_GLOBAL_API_KEY"
Notas Importantes
- Solo Claves Globales de API: Todos los endpoints de inquilinos requieren claves globales de API
- Límites de Licencia: Monitoree el número de inquilinos contra los límites de licencia
- Operaciones Destructivas: La eliminación de inquilinos es permanente e irreversible
- Triple Verificación: Las operaciones de eliminación requieren que ID, nombre y nombre para mostrar coincidan exactamente
- Deshabilitar vs Eliminar: Considere deshabilitar inquilinos para preservar datos mientras se evita el acceso