Lista de documentos
En esta página

Referencia API: Tenants

Endpoints de Tenant

Obtener Tenant

Recupera los detalles de un tenant específico.

Endpoint: GET /tenant/{tenantId}

Parámetros:

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpathIdentificador único del tenant

Response:

{
	"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"displayName": "Mi Empresa",
	"createdAt": "2024-01-15T10:30:00Z",
	"plan": "professional"
}

Actualizar Tenant

Actualiza configuraciones del tenant como el nombre visible.

Endpoint: PUT /tenant/{tenantId}

Parámetros:

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpathIdentificador único del tenant

Request Body:

{
	"displayName": "Nuevo Nombre de Empresa"
}

Response: Devuelve el tenant actualizado.


Consultar Estadísticas de Tenant

Recupera estadísticas de uso del tenant.

Endpoint: GET /tenant/{tenantId}/statistics

Parámetros:

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpathIdentificador único del tenant

Response:

{
	"processCount": 15,
	"datasetCount": 8,
	"userCount": 5,
	"storageUsedBytes": 1073741824
}

Endpoints de Usuarios de Tenant

Listar Usuarios del Tenant

Recupera todos los usuarios que tienen acceso a un tenant.

Endpoint: GET /tenant/{tenantId}/users

Parámetros:

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpathIdentificador único del tenant

Response:

[
	{
		"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
		"email": "user@example.com",
		"firstName": "John",
		"lastName": "Doe",
		"createdAt": "2024-01-15T10:30:00Z",
		"lastLoginAt": "2024-03-01T14:00:00Z",
		"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
		"isActiveInTenant": true,
		"isAdminInTenant": false,
		"isDeveloperInTenant": false,
		"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
		"isActiveInOrganization": true,
		"isAdminInOrganization": false
	}
]

Añadir Usuario al Tenant

Añade un nuevo usuario a un tenant. El usuario se creará si no existe o se añadirá al tenant si ya tiene una cuenta. El ID del usuario se retorna en la respuesta.

Endpoint: POST /tenant/{tenantId}/users

Parámetros:

NombreTipoUbicaciónRequeridoDescripción
tenantIdstringpathIdentificador único del tenant

Request Body:

{
	"email": "newuser@example.com",
	"firstName": "John",
	"lastName": "Doe",
	"isAdminInTenant": false,
	"isActiveInTenant": true,
	"isDeveloperInTenant": false
}
CampoTipoRequeridoDescripción
emailstringEmail del usuario
firstNamestringNoNombre del usuario
lastNamestringNoApellido del usuario
isAdminInTenantbooleanNoSi tiene permisos admin en este tenant
isActiveInTenantbooleanNoSi el usuario está activo en este tenant
isDeveloperInTenantbooleanNoSi tiene acceso developer en este tenant

Response:

{
	"id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"message": "Usuario añadido al tenant."
}

Actualizar Usuario de Tenant

Actualiza los permisos de un usuario dentro del tenant.

Endpoint: PUT /tenant/{tenantId}/users

Request Body:

{
	"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"isAdminInTenant": true,
	"isActiveInTenant": true,
	"isDeveloperInTenant": false
}
CampoTipoRequeridoDescripción
userIdstringIdentificador único del usuario
tenantIdstringIdentificador único del tenant
isAdminInTenantbooleanNoSi el usuario tiene permisos admin
isActiveInTenantbooleanNoSi el usuario está activo en el tenant
isDeveloperInTenantbooleanNoSi el usuario tiene acceso developer

Response:

{
	"message": "Permisos de usuario en tenant actualizados."
}

Eliminar Usuario del Tenant

Elimina el acceso de un usuario a un tenant.

Endpoint: DELETE /tenant/{tenantId}/users

Request Body:

{
	"userId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
	"tenantId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
CampoTipoRequeridoDescripción
userIdstringIdentificador único del usuario a eliminar
tenantIdstringIdentificador único del tenant

Response:

{
	"message": "Usuario eliminado del tenant."
}