Referencia de la API: inquilinos

Obtener información del inquilino

Endpoint: GET /v1/tenant/{tenantId}

Autenticación: Clave de API asociada al inquilino · read ámbito

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid

Respuesta (200):

Detalles del inquilino

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Formato: uuid
createdBy	string	Sí	Formato: uuid
createdAt	string	Sí	Formato: date-time
displayName	string	Sí	Valor predeterminado: "" Longitud máxima: 128
contactEmail	string	Sí	Formato: email
isActive	boolean	Sí	Valor predeterminado: true
shortName	string	Sí
useOrganizationTheme	boolean	Sí	Valor predeterminado: true
description	string	Sí	Longitud máxima: 200
organizationId	string	Sí	Formato: uuid
allowedLogins	object	Sí
tenantType	normal | sandbox | demo	Sí	Valores permitidos: normal, sandbox, demo Valor predeterminado: normal
url	string	Sí	Formato: uri

Errores:

• 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
• 404 No se encontró el recurso

Actualizar la configuración del inquilino

Endpoint: PUT /v1/tenant/{tenantId}

Autenticación: Clave de API asociada al inquilino · write ámbito

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid

Cuerpo de la solicitud:

{
	"id": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"contactEmail": "string",
	"shortName": "string",
	"description": "string"
}

Campo	Tipo	Obligatorio	Descripción
id	string	No	Formato: uuid
displayName	string	No
contactEmail	string	No
shortName	string	No
description	string	No

Respuesta (200):

Inquilino actualizado

{
	"id": "00000000-0000-0000-0000-000000000000",
	"createdBy": "00000000-0000-0000-0000-000000000000",
	"createdAt": "2024-03-15T16:30:00Z",
	"displayName": "string",
	"contactEmail": "string",
	"isActive": true,
	"shortName": "string",
	"useOrganizationTheme": true,
	"description": "string",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"allowedLogins": {
		"Microsoft": true,
		"Google": true,
		"LinkedIn": true
	},
	"tenantType": "normal",
	"url": "string"
}

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Formato: uuid
createdBy	string	Sí	Formato: uuid
createdAt	string	Sí	Formato: date-time
displayName	string	Sí	Valor predeterminado: "" Longitud máxima: 128
contactEmail	string	Sí	Formato: email
isActive	boolean	Sí	Valor predeterminado: true
shortName	string	Sí
useOrganizationTheme	boolean	Sí	Valor predeterminado: true
description	string	Sí	Longitud máxima: 200
organizationId	string	Sí	Formato: uuid
allowedLogins	object	Sí
tenantType	normal | sandbox | demo	Sí	Valores permitidos: normal, sandbox, demo Valor predeterminado: normal
url	string	Sí	Formato: uri

Errores:

• 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de archivo no admitido o un campo obligatorio ausente
• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado
• 403 La Clave de API no tiene el alcance necesario ni acceso a la organización, el Tenant está inactivo o el plan no admite este tipo de archivo
• 406 No se puede aceptar el valor (por ejemplo, porque el nombre corto está reservado o duplicado)

Consultar estadísticas del Tenant (tamaño de los datos, modelos, simulaciones y usuarios)

Endpoint: GET /v1/tenant/{tenantId}/statistics

Autenticación: Clave de API con alcance de Tenant · alcance read

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid

Respuesta (200):

Estadísticas del Tenant

{
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"uploadedDataSize": 0,
	"uploadedDataCount": 0,
	"modelCount": 0,
	"simulationCount": 0,
	"userCount": 0
}

Campo	Tipo	Obligatorio	Descripción
tenantId	string	Sí	Formato: uuid
uploadedDataSize	number	Sí
uploadedDataCount	number	Sí
modelCount	number	Sí
simulationCount	number	Sí
userCount	number	Sí

Errores:

• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado
• 404 No se encontró el recurso

Listar los usuarios del Tenant

Devuelve los usuarios que coinciden en una matriz JSON sin envoltorio: no incluye el total. Use limit/offset para paginar.

Endpoint: GET /v1/tenant/{tenantId}/users

Autenticación: Clave de API con alcance de Tenant · alcance read

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid
limit	integer	consulta	No	Número máximo de elementos que se devolverán
offset	integer	consulta	No	Número de elementos que se omitirán

Respuesta (200):

Lista de usuarios

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"isActiveInTenant": true,
		"isAdminInTenant": true,
		"access": "none",
		"isDashboardViewer": true,
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"isActiveInOrganization": true,
		"isAdminInOrganization": true
	}
]

Errores:

• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado

Añadir un usuario al Tenant (no se envía ningún correo de invitación)

Los campos de roles del cuerpo (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) se respetan tal cual. Este endpoint permite administrar por completo el Tenant, por lo que solo debe proporcionar claves con permisos de escritura a usuarios de confianza. El acceso de solo lectura a los Dashboards se controla con el valor booleano isDashboardViewer; se ha eliminado el nivel heredado de usuario de solo lectura.

Endpoint: POST /v1/tenant/{tenantId}/users

Autenticación: Clave de API con alcance de Tenant · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid

Cuerpo de la solicitud:

{
	"email": "string",
	"firstName": "string",
	"lastName": "string",
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true,
	"preferredLocale": "en"
}

Campo	Tipo	Obligatorio	Descripción
email	string	Sí	Dirección de correo electrónico del usuario (también es su identidad de inicio de sesión) Formato: email
firstName	string	No	Nombre opcional Longitud máxima: 64
lastName	string	No	Apellidos opcionales Longitud máxima: 64
isActiveInTenant	boolean	No	Indica si el usuario está activo en este Tenant
isAdminInTenant	boolean	No	Permisos de administración en este Tenant (se respetan tal cual: acceso completo a las funciones de administración del Tenant)
access	none | portalViewer | designer | architect | intelligence	No	Licencia de selección única: none | portalViewer | designer | architect | intelligence Valores permitidos: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	No	Indica si el usuario tiene acceso de solo lectura a los Dashboards
preferredLocale	en | zh | es | fr | de | pt | it | nl | ja | tr | pl | cs | hu | id | ko | vi | th	No	Idioma preferido de la interfaz para el usuario Valores permitidos: en, zh, es, fr, de, pt, it, nl, ja, tr, pl, cs, hu, id, ko, vi, th

Respuesta (201):

Usuario añadido

{
	"id": "string",
	"message": "string"
}

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	ID del usuario que se acaba de añadir
message	string	Sí

Errores:

• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado
• 409 La solicitud entra en conflicto con el estado actual (por ejemplo, por un límite de licencias o porque se reutilizó un ID)

Actualizar la configuración de un usuario en el Tenant

Endpoint: PUT /v1/tenant/{tenantId}/users/{userId}

Autenticación: Clave de API con alcance de Tenant · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid
userId	string	ruta	Sí	Formato: uuid

Cuerpo de la solicitud:

{
	"isActiveInTenant": true,
	"isAdminInTenant": true,
	"access": "none",
	"isDashboardViewer": true
}

Campo	Tipo	Obligatorio	Descripción
isActiveInTenant	boolean	No	Indica si el usuario está activo en este Tenant
isAdminInTenant	boolean	No	Permisos de administración en este Tenant (se respetan tal cual: permiten administrar el Tenant por completo)
access	none | portalViewer | designer | architect | intelligence	No	Licencia de selección única: none | portalViewer | designer | architect | intelligence. El acceso de solo lectura a los Dashboards se controla con el valor booleano isDashboardViewer. Valores permitidos: none, portalViewer, designer, architect, intelligence
isDashboardViewer	boolean	No	Indica si el usuario tiene acceso de solo lectura a los Dashboards

Respuesta (200):

Actualizado

{
	"message": "string"
}

Campo	Tipo	Obligatorio	Descripción
message	string	Sí

Errores:

• 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de archivo no admitido o un campo obligatorio ausente
• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado
• 404 No se encontró el recurso

Eliminar un usuario del Tenant

Endpoint: DELETE /v1/tenant/{tenantId}/users/{userId}

Autenticación: Clave de API con alcance de Tenant · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid
userId	string	ruta	Sí	Formato: uuid

Respuesta (200):

Usuario eliminado

{
	"message": "string"
}

Campo	Tipo	Obligatorio	Descripción
message	string	Sí

Errores:

• 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de archivo no admitido o un campo obligatorio ausente
• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado
• 404 No se encontró el recurso

Generar un token de acceso de un solo uso para un usuario

Devuelve un token de un solo uso (vigencia de 60 s) asociado al usuario, al Tenant y a la organización, además de la url a la que debe dirigirse el navegador del usuario. Abra la URL en el navegador del usuario para que acceda a ProcessMind con la sesión iniciada: no se envía ningún enlace por correo ni se suplanta la identidad; el usuario obtiene su propia sesión. La Clave de API debe tener el alcance específico sessions: una clave con alcance de organización puede generar el token para cualquier Tenant de esa organización; una clave con alcance de Tenant solo puede hacerlo para usuarios de su propio Tenant. Trate el token como una contraseña: solo se devuelve una vez, nunca se registra y se revoca al deshabilitar la clave o al usuario.

Endpoint: POST /v1/tenant/{tenantId}/users/{userId}/login-token

Autenticación: Clave de API con alcance de Tenant o de organización · alcance sessions · límite de frecuencia: 2 solicitudes/s (ráfaga de 4)

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid
userId	string	ruta	Sí	Formato: uuid

Cuerpo de la solicitud:

Ruta de destino opcional (ruta relativa de la aplicación, por ejemplo, “app” o “app/dashboards”)

{
	"path": "string"
}

Campo	Tipo	Obligatorio	Descripción
path	string	No	Longitud máxima: 512

Respuesta (200):

Token de acceso

{
	"token": "string",
	"url": "string",
	"expiresInSeconds": 0,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Campo	Tipo	Obligatorio	Descripción
token	string	Sí
url	string	Sí
expiresInSeconds	number	Sí
expiresAt	string	Sí	Formato: date-time

Errores:

• 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de archivo no admitido o un campo obligatorio ausente
• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado
• 403 La Clave de API no tiene el alcance necesario ni acceso a la organización, el Tenant está inactivo o el plan no admite este tipo de archivo
• 404 No se encontró el recurso
• 429 Se superó el límite de solicitudes: consulte el límite de frecuencia documentado para el endpoint

Las Claves de API autentican sus integraciones. Las claves con alcance de organización pueden aprovisionar y administrar las claves de cualquier Tenant de la organización.

Listar las Claves de API del Tenant

Se requiere una Clave de API con alcance de organización. El secreto nunca se devuelve.

Endpoint: GET /v1/tenant/{tenantId}/api-keys

Autenticación: Clave de API con alcance de organización · alcance read

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid
limit	integer	consulta	No	Número máximo de elementos que se devolverán
offset	integer	consulta	No	Número de elementos que se omitirán

Respuesta (200):

Lista de Claves de API

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"tenantId": "00000000-0000-0000-0000-000000000000",
		"organizationId": "00000000-0000-0000-0000-000000000000",
		"displayName": "string",
		"partialKey": "string",
		"enabled": true,
		"createdAt": "2024-03-15T16:30:00Z",
		"lastUsedAt": "2024-03-15T16:30:00Z",
		"expiresAt": "2024-03-15T16:30:00Z",
		"scope": {
			"read": true,
			"write": true,
			"uploadData": true,
			"sessions": true
		}
	}
]

Errores:

• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado
• 403 La Clave de API no tiene el alcance necesario ni acceso a la organización, el Tenant está inactivo o el plan no admite este tipo de archivo

Crear una Clave de API con alcance de Tenant

Se requiere una Clave de API de escritura con alcance de organización. El secreto se genera en el servidor y se devuelve una sola vez en la respuesta; guárdelo en un lugar seguro. Solo se conserva su hash.

Endpoint: POST /v1/tenant/{tenantId}/api-keys

Autenticación: Clave de API con alcance de organización · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid

Cuerpo de la solicitud:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Campo	Tipo	Obligatorio	Descripción
displayName	string	Sí	Longitud máxima: 128
scope	object	No
enabled	boolean	No
expiresAt	string	No	Formato: date-time

Respuesta (201):

Clave de API creada (incluye el secreto de un solo uso)

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"secret": "string"
}

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Formato: uuid
tenantId	string	Sí	Formato: uuid
organizationId	string	Sí	Formato: uuid
displayName	string	Sí	Longitud máxima: 128
partialKey	string	Sí	Longitud máxima: 128
enabled	boolean	Sí	Valor predeterminado: true
createdAt	string	Sí	Formato: date-time
lastUsedAt	string	Sí	Formato: date-time
expiresAt	string	Sí	Formato: date-time
scope	object	Sí
secret	string	Sí	Longitud máxima: 128

Errores:

• 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de archivo no admitido o un campo obligatorio ausente
• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado
• 403 La Clave de API no tiene el alcance necesario ni acceso a la organización, el Tenant está inactivo o el plan no admite este tipo de archivo

Actualizar una Clave de API con alcance de Tenant

Se requiere una Clave de API de escritura con alcance de organización. Los campos del alcance se combinan con el alcance guardado.

Endpoint: PUT /v1/tenant/{tenantId}/api-keys/{keyId}

Autenticación: Clave de API con alcance de organización · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid
keyId	string	ruta	Sí	Formato: uuid

Cuerpo de la solicitud:

{
	"displayName": "string",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Campo	Tipo	Obligatorio	Descripción
displayName	string	No	Longitud máxima: 128
scope	object	No
enabled	boolean	No
expiresAt	string	No	Formato: date-time

Respuesta (200):

Clave de API actualizada

{
	"id": "00000000-0000-0000-0000-000000000000",
	"tenantId": "00000000-0000-0000-0000-000000000000",
	"organizationId": "00000000-0000-0000-0000-000000000000",
	"displayName": "string",
	"partialKey": "string",
	"enabled": true,
	"createdAt": "2024-03-15T16:30:00Z",
	"lastUsedAt": "2024-03-15T16:30:00Z",
	"expiresAt": "2024-03-15T16:30:00Z",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	}
}

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Formato: uuid
tenantId	string	Sí	Formato: uuid
organizationId	string	Sí	Formato: uuid
displayName	string	Sí	Longitud máxima: 128
partialKey	string	Sí	Longitud máxima: 128
enabled	boolean	Sí	Valor predeterminado: true
createdAt	string	Sí	Formato: date-time
lastUsedAt	string	Sí	Formato: date-time
expiresAt	string	Sí	Formato: date-time
scope	object	Sí

Errores:

• 400 Solicitud incorrecta: por ejemplo, una expresión de filtro no válida, un proceso sin modelo, un tipo de archivo no admitido o un campo obligatorio ausente
• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado
• 403 La Clave de API no tiene el alcance necesario ni acceso a la organización, el Tenant está inactivo o el plan no admite este tipo de archivo
• 404 No se encontró el recurso

Eliminar una Clave de API con alcance de Tenant

Se requiere una Clave de API de escritura con alcance de organización. La clave se elimina de forma lógica y deja de autenticar de inmediato.

Endpoint: DELETE /v1/tenant/{tenantId}/api-keys/{keyId}

Autenticación: Clave de API con alcance de organización · alcance write

Parámetros:

Nombre	Tipo	Ubicación	Obligatorio	Descripción
tenantId	string	ruta	Sí	Formato: uuid
keyId	string	ruta	Sí	Formato: uuid

Respuesta (200):

Clave de API eliminada

{
	"message": "string"
}

Campo	Tipo	Obligatorio	Descripción
message	string	Sí

Errores:

• 401 Falta la Clave de API, no es válida, está deshabilitada o ha caducado
• 403 La Clave de API no tiene el alcance necesario ni acceso a la organización, el Tenant está inactivo o el plan no admite este tipo de archivo
• 404 No se encontró el recurso