Riferimento API: organizzazioni

Le organizzazioni riuniscono più Tenant sotto un’unica entità.

Recuperare l’organizzazione del Tenant

La lettura è consentita con una chiave API associata al Tenant; è accettata anche una chiave associata all’organizzazione.

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

Autenticazione: Chiave API associata al Tenant o all’organizzazione · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	percorso	Sì	Formato: uuid

Risposta (200):

Dettagli dell’organizzazione

{
	"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	Obbligatorio	Descrizione
id	string	Sì	Formato: uuid
displayName	string	Sì	Valore predefinito: "" Lunghezza massima: 128
createdAt	string	Sì	Formato: date-time
contactEmail	string	Sì	Formato: email
isActive	boolean	Sì	Valore predefinito: true
allowedLogins	object	Sì
createdBy	string	Sì	Formato: uuid

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 404 Risorsa non trovata

Recuperare la capacità di postazioni dell’organizzazione e i criteri di sincronizzazione automatica

Restituisce, per ogni livello (Fondamenti dei processi, Architettura dei processi, Process Intelligence), il numero di postazioni acquistate e in uso a livello di organizzazione, la quota di postazioni gratuite per i visualizzatori, la destinazione della sincronizzazione automatica, una spiegazione delle differenze nel numero di postazioni (cosa farà il motore e quando), l’intervallo di fatturazione e externalApiSeatPolicy. La lettura è consentita con una chiave API associata al Tenant. Il parametro di percorso {tenantId} identifica il Tenant di contesto (l’organizzazione a cui è associata la chiave a livello di organizzazione), non il destinatario dell’operazione.

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

Autenticazione: Chiave API associata al Tenant o all’organizzazione · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	percorso	Sì	Formato: uuid

Risposta (200):

Capacità di postazioni

{
	"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	Obbligatorio	Descrizione
contractType	free | selfServe | fixed | unlimited	Sì	Valori consentiti: 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ì	Valori consentiti: month, year
nextBilledAt	string	Sì
externalApiSeatPolicy	autoBill | requireCapacity	Sì	Valori consentiti: autoBill, requireCapacity

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 404 Risorsa non trovata

Recuperare le statistiche dell’organizzazione

Il parametro di percorso {tenantId} identifica il Tenant di contesto (l’organizzazione a cui è associata la chiave a livello di organizzazione), non il destinatario dell’operazione.

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

Autenticazione: Chiave API associata all’organizzazione · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	percorso	Sì	Formato: uuid

Risposta (200):

Statistiche dell’organizzazione

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

Campo	Tipo	Obbligatorio	Descrizione
userCount	number	Sì
tenantCount	number	Sì
tenantStatistics	object[]	Sì

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta

Elencare tutti i Tenant dell’organizzazione

Il parametro di percorso {tenantId} identifica il Tenant di contesto (l’organizzazione a cui è associata la chiave a livello di organizzazione), non il destinatario dell’operazione.

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

Autenticazione: Chiave API associata all’organizzazione · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	percorso	Sì	Formato: uuid
limit	integer	query	No	Numero massimo di elementi da restituire
offset	integer	query	No	Numero di elementi da ignorare

Risposta (200):

Elenco dei Tenant

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

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta

Creare un Tenant nell’organizzazione (richiede una chiave API associata all’organizzazione)

Il parametro di percorso {tenantId} identifica il Tenant di contesto (l’organizzazione a cui è associata la chiave a livello di organizzazione), non il destinatario dell’operazione.

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

Autenticazione: Chiave API con ambito organizzazione · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: uuid

Corpo della richiesta:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string",
	"timezone": "string",
	"tenantType": "normal"
}

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	No	Lunghezza massima: 128
shortName	string	Sì
description	string	No	Lunghezza massima: 200
timezone	string	No	Lunghezza massima: 64
tenantType	normal | sandbox | demo	No	Valori consentiti: normal, sandbox, demo

Risposta (201):

Tenant creato

{
	"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	Obbligatorio	Descrizione
id	string	Sì	Formato: uuid
createdBy	string	Sì	Formato: uuid
createdAt	string	Sì	Formato: date-time
displayName	string	Sì	Valore predefinito: "" Lunghezza massima: 128
contactEmail	string	Sì	Formato: email
isActive	boolean	Sì	Valore predefinito: true
shortName	string	Sì
useOrganizationTheme	boolean	Sì	Valore predefinito: true
description	string	Sì	Lunghezza massima: 200
organizationId	string	Sì	Formato: uuid
allowedLogins	object	Sì
tenantType	normal | sandbox | demo	Sì	Valori consentiti: normal, sandbox, demo Valore predefinito: normal
url	string	Sì	Formato: uri

Errori:

• 400 Richiesta non valida: ad esempio, espressione di filtro non valida, processo senza modello, tipo di file non supportato o campo obbligatorio mancante
• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 403 La chiave API non dispone dell’ambito richiesto o dell’accesso all’organizzazione, il Tenant è inattivo oppure il piano non consente il tipo di file
• 406 Il valore non può essere accettato (ad esempio, un nome breve riservato o già utilizzato)

Eliminare logicamente un Tenant nell’organizzazione (richiede una chiave API con ambito organizzazione)

L’accesso API per il Tenant viene interrotto immediatamente. Il Tenant e i relativi dati vengono conservati durante il periodo di sicurezza dell’eliminazione e rimossi in seguito dall’eliminazione completa automatizzata. Non è possibile eliminare il Tenant attualmente in uso (il Tenant di contesto).

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

Autenticazione: Chiave API con ambito organizzazione · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: uuid
targetId	string	path	Sì	Formato: uuid

Risposta (200):

Tenant eliminato

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

Campo	Tipo	Obbligatorio	Descrizione
success	boolean	Sì
message	string	Sì

Errori:

• 400 Richiesta non valida: ad esempio, espressione di filtro non valida, processo senza modello, tipo di file non supportato o campo obbligatorio mancante
• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 403 La chiave API non dispone dell’ambito richiesto o dell’accesso all’organizzazione, il Tenant è inattivo oppure il piano non consente il tipo di file
• 404 Risorsa non trovata

Ripristinare un Tenant eliminato logicamente nell’organizzazione (richiede una chiave API con ambito organizzazione)

Annulla un’eliminazione logica entro il periodo di sicurezza: il Tenant e i relativi dati vengono ripristinati esattamente com’erano e l’accesso API riprende. Il parametro di percorso {tenantId} indica il Tenant di contesto (l’organizzazione associata alla chiave con ambito organizzazione), non il Tenant interessato dall’operazione.

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

Autenticazione: Chiave API con ambito organizzazione · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: uuid
targetId	string	path	Sì	Formato: uuid

Risposta (200):

Tenant ripristinato

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

Campo	Tipo	Obbligatorio	Descrizione
success	boolean	Sì
message	string	Sì

Errori:

• 400 Richiesta non valida: ad esempio, espressione di filtro non valida, processo senza modello, tipo di file non supportato o campo obbligatorio mancante
• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 403 La chiave API non dispone dell’ambito richiesto o dell’accesso all’organizzazione, il Tenant è inattivo oppure il piano non consente il tipo di file
• 404 Risorsa non trovata

Elencare tutti gli utenti dell’organizzazione

Il parametro di percorso {tenantId} indica il Tenant di contesto (l’organizzazione associata alla chiave con ambito organizzazione), non il Tenant interessato dall’operazione.

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

Autenticazione: Chiave API con ambito organizzazione · ambito read

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: uuid
limit	integer	query	No	Numero massimo di elementi da restituire
offset	integer	query	No	Numero di elementi da ignorare

Risposta (200):

Elenco degli utenti dell’organizzazione

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

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta

Aggiornare le impostazioni di un utente dell’organizzazione (richiede una chiave API con ambito organizzazione)

I flag dei ruoli nel corpo della richiesta (isAdminInOrganization, isActiveInOrganization) vengono applicati esattamente come specificati; le chiavi con ambito organizzazione devono essere rilasciate solo agli amministratori dell’organizzazione. Il parametro di percorso {tenantId} indica il Tenant di contesto (l’organizzazione associata alla chiave con ambito organizzazione), non il Tenant interessato dall’operazione.

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

Autenticazione: Chiave API con ambito organizzazione · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: uuid
userId	string	path	Sì	Formato: uuid

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
isActiveInOrganization	boolean	No	Indica se l’utente è attivo nell’organizzazione
isAdminInOrganization	boolean	No	Diritti di amministratore dell’organizzazione (applicati esattamente come specificati: rilasciare chiavi con ambito organizzazione solo agli amministratori dell’organizzazione)

Risposta (200):

Aggiornato

{
	"message": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
message	string	Sì

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 403 La chiave API non dispone dell’ambito richiesto o dell’accesso all’organizzazione, il Tenant è inattivo oppure il piano non consente il tipo di file
• 404 Risorsa non trovata

Rimuovere un utente dall’organizzazione (richiede una chiave API con ambito organizzazione)

Il parametro di percorso {tenantId} indica il Tenant di contesto (l’organizzazione associata alla chiave con ambito organizzazione), non il Tenant interessato dall’operazione.

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

Autenticazione: Chiave API con ambito organizzazione · ambito write

Parametri:

Nome	Tipo	Posizione	Obbligatorio	Descrizione
tenantId	string	path	Sì	Formato: uuid
userId	string	path	Sì	Formato: uuid

Risposta (200):

Utente rimosso

{
	"message": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
message	string	Sì

Errori:

• 401 Chiave API mancante, non valida, disabilitata o scaduta
• 403 La chiave API non dispone dell’ambito richiesto o dell’accesso all’organizzazione, il Tenant è inattivo oppure il piano non consente il tipo di file
• 404 Risorsa non trovata