Referencia API: Tenants
Referencia API para gestión de tenants y control de acceso de usuarios.
En esta página
Referencia API: Organizaciones
Endpoints de organizaciones
Las organizaciones agrupan múltiples tenants bajo una sola entidad.
Obtener organización
Recupera información de la organización a la que pertenece un tenant.
Endpoint: GET /tenant/{tenantId}/organization
Parámetros:
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | Identificador único del tenant |
Respuesta:
{
"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"displayName": "Acme Corporation",
"createdAt": "2023-06-01T00:00:00Z"
}
Obtener estadísticas de la organización
Obtén estadísticas agregadas de toda la organización.
Endpoint: GET /tenant/{tenantId}/organization/statistics
Parámetros:
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | Identificador único del tenant |
Respuesta:
{
"tenantCount": 5,
"totalProcessCount": 42,
"totalDatasetCount": 18,
"totalUserCount": 25,
"totalStorageUsedBytes": 5368709120
}
Listar tenants de la organización
Obtén todos los tenants de la organización.
Endpoint: GET /tenant/{tenantId}/organization/tenants
Parámetros:
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | Identificador único del tenant |
Respuesta:
[
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"displayName": "Sales Department",
"createdAt": "2024-01-01T00:00:00Z"
},
{
"id": "d4e5f6a7-b8c9-0123-def4-567890123456",
"displayName": "Operations",
"createdAt": "2024-02-15T00:00:00Z"
}
]
Crear Tenant
Crea un nuevo tenant en la organización.
Endpoint: POST /tenant/{tenantId}/organization/tenants
Parámetros:
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | Identificador único de un tenant existente en la organización |
Body de la solicitud:
{
"shortName": "sales-team",
"displayName": "Sales Team",
"description": "Tenant para el departamento de ventas"
}
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| shortName | string | Sí | Identificador URL-friendly (minúsculas, se permiten guiones) |
| displayName | string | No | Nombre visible para el tenant |
| description | string | No | Descripción del tenant |
Respuesta: Devuelve el objeto del tenant creado.
Eliminar Tenant
Elimina un tenant de la organización.
Endpoint: DELETE /tenant/{tenantId}/organization/tenants/{targetTenantId}
Parámetros:
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | Identificador único de un tenant existente en la organización |
| targetTenantId | string | path | Sí | Identificador único del tenant a eliminar |
Respuesta:
{
"success": true
}
warning
Al eliminar un tenant se eliminarán permanentemente todos sus procesos, datasets y asignaciones de usuarios. Esta acción no se puede deshacer. No puedes eliminar el tenant que estás utilizando para autenticarte.
Endpoints de usuarios de la organización
Listar usuarios de la organización
Obtén todos los usuarios de la organización.
Endpoint: GET /tenant/{tenantId}/organization/users
Parámetros:
| Nombre | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
| tenantId | string | path | Sí | Identificador único del tenant |
Respuesta:
[
{
"id": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"email": "admin@example.com",
"firstName": "Jane",
"lastName": "Smith",
"createdAt": "2023-06-01T00:00:00Z",
"lastLoginAt": "2024-03-01T10:00:00Z",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": true
}
]
Actualizar usuario de la organización
Actualiza los permisos de un usuario dentro de la organización.
Endpoint: PUT /tenant/{tenantId}/organization/users
Body de la solicitud:
{
"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": true
}
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| userId | string | Sí | Identificador único del usuario |
| organizationId | string | Sí | Identificador único de la organización |
| isActiveInOrganization | boolean | No | Indica si el usuario está activo en la organización |
| isAdminInOrganization | boolean | No | Indica si el usuario tiene permisos de admin en la organización |
Respuesta:
{
"message": "Configuración del usuario en la organización actualizada."
}
Eliminar usuario de la organización
Elimina completamente un usuario de la organización.
Endpoint: DELETE /tenant/{tenantId}/organization/users
Body de la solicitud:
{
"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234"
}
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
| userId | string | Sí | Identificador único del usuario a eliminar |
| organizationId | string | Sí | Identificador único de la organización |
Respuesta:
{
"message": "Usuario eliminado de la organización."
}
warning
Al remover un usuario de la organización se revocará su acceso a todos los tenants asociados.