En esta página
> recursos > documentacion > api > Referencia de API: Organizaciones

Referencia de API: Organizaciones

warning

Eliminar un inquilino quitará permanentemente todos sus procesos, conjuntos de datos y asignaciones de usuarios. Esta acción no se puede deshacer. No puede eliminar el inquilino que utiliza para autenticarse.

warning

Quitar a un usuario de la organización revocará su acceso a todos los inquilinos de la organización.

Las organizaciones agrupan varios inquilinos bajo una sola entidad.

Obtener la organización del inquilino

Se puede leer 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 u 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í Predeterminado: ""
Longitud máxima: 128
createdAt string Sí Formato: date-time
contactEmail string Sí Formato: email
isActive boolean Sí 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 Recurso no encontrado

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

Devuelve las licencias compradas y en uso de toda la organización para cada nivel (Process Foundation, Process Architecture, Process Intelligence), la asignación de usuarios de solo lectura gratuitos, el objetivo de sincronización automática, la explicación de las diferencias de licencias (qué hará el motor y cuándo), el intervalo de facturación y externalApiSeatPolicy. Se puede leer con una clave de API con alcance de inquilino. El parámetro de ruta {tenantId} es el inquilino de contexto (la organización de la clave con alcance de organización), no el objetivo de la operación.

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

Autenticación: Clave de API con alcance de inquilino u 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,
	"totalBillable": 0,
	"freeViewerAllowance": 0,
	"freeViewerOverAllowance": 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í
totalBillable number Sí
freeViewerAllowance number Sí
freeViewerOverAllowance 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 Recurso no encontrado

Obtener las estadísticas de toda la organización

El parámetro de ruta {tenantId} es el inquilino de contexto (la organización de la clave con alcance de organización), no el objetivo 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} es el inquilino de contexto (la organización de la clave con alcance de organización), no el objetivo 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
		},
		"url": "string"
	}
]

Errores:

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

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

El parámetro de ruta {tenantId} es el inquilino de contexto (la organización de la clave con alcance de organización), no el objetivo 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"
}
Campo Tipo Obligatorio Descripción
displayName string No Longitud máxima: 128
shortName string Sí
description string No Longitud máxima: 200

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
	},
	"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í Predeterminado: ""
Longitud máxima: 128
contactEmail string Sí Formato: email
isActive boolean Sí Predeterminado: true
shortName string Sí
useOrganizationTheme boolean Sí Predeterminado: true
description string Sí Longitud máxima: 200
organizationId string Sí Formato: uuid
allowedLogins object Sí
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 carga no compatible o la falta de un campo obligatorio
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 403 La clave de API no tiene el alcance requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 406 No se puede aceptar el valor (por ejemplo, un nombre corto 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 detiene de inmediato. El inquilino y sus datos se conservan durante el periodo de seguridad de eliminación y se eliminan después mediante la eliminación completa automatizada. No se puede eliminar el inquilino que está utilizando 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 carga no compatible o la falta de un campo obligatorio
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 403 La clave de API no tiene el alcance requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 404 Recurso no encontrado

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

Deshace una eliminación lógica dentro del periodo de seguridad de eliminación: el inquilino y sus datos vuelven a estar exactamente como antes y se reanuda el acceso a la API. El parámetro de ruta {tenantId} es el inquilino de contexto (la organización de la clave con alcance de organización), no el 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 carga no compatible o la falta de un campo obligatorio
  • 401 Falta la clave de API, no es válida, está deshabilitada o ha caducado
  • 403 La clave de API no tiene el alcance requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 404 Recurso no encontrado

Enumerar todos los usuarios de la organización

El parámetro de ruta {tenantId} es el inquilino de contexto (la organización de la clave con alcance de organización), no el 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)

Las marcas de rol del cuerpo (isAdminInOrganization, isActiveInOrganization) se aplican literalmente; emita claves con alcance de organización únicamente a administradores de la organización. El parámetro de ruta {tenantId} es el inquilino de contexto (la organización de la clave con alcance de organización), no el 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 Derechos de administrador de la organización (se aplican literalmente: emita claves con alcance de organización únicamente a administradores de la organización)

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 requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 404 Recurso no encontrado

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

El parámetro de ruta {tenantId} es el inquilino de contexto (la organización de la clave con alcance de organización), no el 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 requerido o acceso a la organización, el inquilino está inactivo o el plan bloquea el tipo de archivo
  • 404 Recurso no encontrado

Documentación relacionada