Referencia de API: organizaciones

Las organizaciones agrupan varios inquilinos bajo una misma entidad.

Obtener la organización del inquilino

Se puede consultar con una clave de API con alcance de inquilino; también se acepta una clave con alcance de organización.

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

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

Parámetros:

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

Respuesta (200):

Detalles de la organización

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

Campo	Tipo	Obligatorio	Descripción
id	string	Sí	Formato: uuid
displayName	string	Sí	Valor predeterminado: "" Longitud máxima: 128
createdAt	string	Sí	Formato: date-time
contactEmail	string	Sí	Formato: email
isActive	boolean	Sí	Valor predeterminado: true
allowedLogins	object	Sí
createdBy	string	Sí	Formato: uuid

Errores:

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

Consultar la capacidad de licencias y la política de sincronización automática de la organización

Devuelve las licencias compradas y en uso en toda la organización para cada nivel (Fundamentos de procesos, Arquitectura de procesos, Inteligencia de procesos), la cantidad permitida de licencias gratuitas de solo lectura, el objetivo de sincronización automática, una explicación de las diferencias entre licencias (qué hará el motor y cuándo), el intervalo de facturación y externalApiSeatPolicy. Se puede consultar con una clave de API con alcance de inquilino. El parámetro de ruta {tenantId} corresponde al inquilino de contexto (la organización asociada a la clave con alcance de organización), no al destino de la operación.

Endpoint: GET /v1/tenant/{tenantId}/organization/billing/seats

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

Parámetros:

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

Respuesta (200):

Capacidad de licencias

{
	"contractType": "free",
	"isTrial": true,
	"purchased": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseBillable": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"inUseFree": 0,
	"inUseDashboardViewers": 0,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 0,
	"dashboardViewerAllowance": 0,
	"dashboardViewerOverAllowance": 0,
	"fixedOverage": 0,
	"target": {
		"foundation": 0,
		"architecture": 0,
		"intelligence": 0
	},
	"drift": [
		{
			"rung": "foundation",
			"paid": 0,
			"actual": 0,
			"state": "equal",
			"buffer": 0
		}
	],
	"interval": "month",
	"nextBilledAt": "string",
	"externalApiSeatPolicy": "autoBill"
}

Campo	Tipo	Obligatorio	Descripción
contractType	free | selfServe | fixed | unlimited	Sí	Valores permitidos: free, selfServe, fixed, unlimited
isTrial	boolean	Sí
purchased	object	Sí
inUseBillable	object	Sí
inUseFree	number	Sí
inUseDashboardViewers	number	Sí
totalBillable	number	Sí
freeViewerAllowance	number	Sí
freeViewerOverAllowance	number	Sí
dashboardViewerAllowance	number	Sí
dashboardViewerOverAllowance	number	Sí
fixedOverage	number	Sí
target	object	Sí
drift	object[]	Sí
interval	month | year	Sí	Valores permitidos: month, year
nextBilledAt	string	Sí
externalApiSeatPolicy	autoBill | requireCapacity	Sí	Valores permitidos: autoBill, requireCapacity

Errores:

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

Consultar las estadísticas de toda la organización

El parámetro de ruta {tenantId} corresponde al inquilino de contexto (la organización asociada a la clave con alcance de organización), no al destino de la operación.

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

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

Respuesta (200):

Estadísticas de la organización

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

Campo	Tipo	Obligatorio	Descripción
userCount	number	Sí
tenantCount	number	Sí
tenantStatistics	object[]	Sí

Errores:

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

Enumerar todos los inquilinos de la organización

El parámetro de ruta {tenantId} corresponde al inquilino de contexto (la organización asociada a la clave con alcance de organización), no al destino de la operación.

Endpoint: GET /v1/tenant/{tenantId}/organization/tenants

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 inquilinos

[
	{
		"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"
	}
]

Errores:

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

Crear un inquilino en la organización (se requiere una clave de API con alcance de organización)

El parámetro de ruta {tenantId} corresponde al inquilino de contexto (la organización asociada a la clave con alcance de organización), no al destino de la operación.

Endpoint: POST /v1/tenant/{tenantId}/organization/tenants

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",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}

Campo	Tipo	Obligatorio	Descripción
displayName	string	No	Longitud máxima: 128
shortName	string	Sí
description	string	No	Longitud máxima: 200
timezone	string	No	Longitud máxima: 64
tenantType	normal | sandbox | demo	No	Valores permitidos: normal, sandbox, demo

Respuesta (201):

Inquilino creado

{
	"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 compatible 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 o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite ese tipo de archivo
• 406 No se puede aceptar el valor (por ejemplo, porque el nombre corto está reservado o duplicado)

Eliminar de forma lógica un inquilino de la organización (requiere una clave de API con alcance de organización)

El acceso a la API del inquilino se interrumpe de inmediato. El inquilino y sus datos se conservan durante el periodo de seguridad previo a la eliminación y, después, se eliminan por completo de forma automática. No se puede eliminar el inquilino que está usando actualmente (el inquilino de contexto).

Endpoint: DELETE /v1/tenant/{tenantId}/organization/tenants/{targetId}

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
targetId	string	ruta	Sí	Formato: uuid

Respuesta (200):

Inquilino eliminado

{
	"success": true,
	"message": "string"
}

Campo	Tipo	Obligatorio	Descripción
success	boolean	Sí
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 compatible 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 o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite ese tipo de archivo
• 404 No se encontró el recurso

Restaurar un inquilino eliminado de forma lógica en la organización (requiere una clave de API con alcance de organización)

Deshaga la eliminación lógica dentro del periodo de seguridad: el inquilino y sus datos se restauran exactamente como estaban y se reanuda el acceso a la API. El parámetro de ruta {tenantId} corresponde al inquilino de contexto (la organización asociada a la clave con alcance de organización), no al objetivo de la operación.

Endpoint: POST /v1/tenant/{tenantId}/organization/tenants/{targetId}/restore

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
targetId	string	ruta	Sí	Formato: uuid

Respuesta (200):

Inquilino restaurado

{
	"success": true,
	"message": "string"
}

Campo	Tipo	Obligatorio	Descripción
success	boolean	Sí
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 compatible 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 o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite ese tipo de archivo
• 404 No se encontró el recurso

Listar todos los usuarios de la organización

El parámetro de ruta {tenantId} corresponde al inquilino de contexto (la organización asociada a la clave con alcance de organización), no al objetivo de la operación.

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

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 usuarios de la organización

[
	{
		"id": "00000000-0000-0000-0000-000000000000",
		"email": "string",
		"firstName": "string",
		"lastName": "string",
		"createdAt": "2024-03-15T16:30:00Z",
		"lastLoginAt": "2024-03-15T16:30:00Z",
		"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

Actualizar la configuración de un usuario de la organización (requiere una clave de API con alcance de organización)

Los indicadores de rol del cuerpo de la solicitud (isAdminInOrganization, isActiveInOrganization) se aplican tal cual; emita claves con alcance de organización únicamente a administradores de la organización. El parámetro de ruta {tenantId} corresponde al inquilino de contexto (la organización asociada a la clave con alcance de organización), no al objetivo de la operación.

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

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
userId	string	ruta	Sí	Formato: uuid

Cuerpo de la solicitud:

{
	"isActiveInOrganization": true,
	"isAdminInOrganization": true
}

Campo	Tipo	Obligatorio	Descripción
isActiveInOrganization	boolean	No	Indica si el usuario está activo en la organización
isAdminInOrganization	boolean	No	Permisos de administración de la organización (se aplican tal cual: emita claves con alcance de organización únicamente a administradores)

Respuesta (200):

Actualizado

{
	"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 o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite ese tipo de archivo
• 404 No se encontró el recurso

Quitar un usuario de la organización (requiere una clave de API con alcance de organización)

El parámetro de ruta {tenantId} corresponde al inquilino de contexto (la organización asociada a la clave con alcance de organización), no al objetivo de la operación.

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

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
userId	string	ruta	Sí	Formato: uuid

Respuesta (200):

Usuario eliminado

{
	"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 o el acceso a la organización necesarios, el inquilino está inactivo o el plan no permite ese tipo de archivo
• 404 No se encontró el recurso