Riferimento API: organizzazioni

Le organizzazioni raggruppano più tenant sotto un’unica entità.

Ottenere l’organizzazione del tenant

La lettura è consentita con una chiave API con ambito tenant; è accettata anche una chiave con ambito organizzazione.

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

Autenticazione: Chiave API con ambito tenant o 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ì	Predefinito: "" Lunghezza massima: 128
createdAt	string	Sì	Formato: date-time
contactEmail	string	Sì	Formato: email
isActive	boolean	Sì	Predefinito: true
allowedLogins	object	Sì
createdBy	string	Sì	Formato: uuid

Errori:

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

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

Restituisce le postazioni acquistate rispetto a quelle in uso a livello di organizzazione per ciascun livello (Process Foundation, Process Architecture, Process Intelligence), la disponibilità di postazioni gratuite per la visualizzazione, la destinazione della sincronizzazione automatica, la spiegazione dello scostamento delle postazioni (che cosa farà il motore e quando), l’intervallo di fatturazione e externalApiSeatPolicy. La lettura è consentita con una chiave API con ambito tenant. Il parametro di percorso {tenantId} identifica il tenant di contesto, ovvero l’organizzazione della chiave con ambito organizzazione, non il destinatario dell’operazione.

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

Autenticazione: Chiave API con ambito tenant o 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,
	"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	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ì
totalBillable	number	Sì
freeViewerAllowance	number	Sì
freeViewerOverAllowance	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

Ottenere le statistiche dell’intera organizzazione

Il parametro di percorso {tenantId} identifica il tenant di contesto, ovvero l’organizzazione della chiave con ambito organizzazione, non il destinatario dell’operazione.

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

Autenticazione: Chiave API con ambito 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, ovvero l’organizzazione della chiave con ambito organizzazione, non il destinatario dell’operazione.

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

Autenticazione: Chiave API con ambito 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
		},
		"url": "string"
	}
]

Errori:

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

Creare un nuovo tenant nell’organizzazione (richiede una chiave API con ambito organizzazione)

Il parametro di percorso {tenantId} identifica il tenant di contesto, ovvero l’organizzazione della chiave con ambito 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	percorso	Sì	Formato: uuid

Corpo della richiesta:

{
	"displayName": "string",
	"shortName": "string",
	"description": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	No	Lunghezza massima: 128
shortName	string	Sì
description	string	No	Lunghezza massima: 200

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
	},
	"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ì	Predefinito: "" Lunghezza massima: 128
contactEmail	string	Sì	Formato: email
isActive	boolean	Sì	Predefinito: true
shortName	string	Sì
useOrganizationTheme	boolean	Sì	Predefinito: true
description	string	Sì	Lunghezza massima: 200
organizationId	string	Sì	Formato: uuid
allowedLogins	object	Sì
url	string	Sì	Formato: uri

Errori:

• 400 Richiesta non valida: ad esempio, un’espressione di filtro non valida, un processo senza modello, un tipo di caricamento non supportato o un 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 duplicato)

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

L’accesso API al tenant viene interrotto immediatamente. Il tenant e i relativi dati vengono conservati durante il periodo di sicurezza dell’eliminazione e rimossi successivamente dall’eliminazione completa automatica. Non è possibile eliminare il tenant attualmente utilizzato, ovvero 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	percorso	Sì	Formato: uuid
targetId	string	percorso	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, un’espressione di filtro non valida, un processo senza modello, un tipo di caricamento non supportato o un 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 durante il periodo di sicurezza dell’eliminazione: il tenant e i relativi dati vengono ripristinati esattamente nello stato precedente e l’accesso API riprende. Il parametro di percorso {tenantId} identifica il tenant di contesto, ovvero l’organizzazione della chiave con ambito organizzazione, non il destinatario dell’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	percorso	Sì	Formato: uuid
targetId	string	percorso	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, un’espressione di filtro non valida, un processo senza modello, un tipo di caricamento non supportato o un 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} identifica il tenant di contesto, ovvero l’organizzazione della chiave con ambito organizzazione, non il destinatario dell’operazione.

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

Autenticazione: Chiave API con ambito 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 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 (isAdminInOrganization, isActiveInOrganization) vengono applicati senza modifiche; assegni chiavi con ambito organizzazione esclusivamente agli amministratori dell’organizzazione. Il parametro di percorso {tenantId} identifica il tenant di contesto, ovvero l’organizzazione della chiave con ambito organizzazione, non il destinatario dell’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	percorso	Sì	Formato: uuid
userId	string	percorso	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 senza modifiche: assegni chiavi con ambito organizzazione esclusivamente 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} identifica il tenant di contesto, ovvero l’organizzazione della chiave con ambito organizzazione, non il destinatario dell’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	percorso	Sì	Formato: uuid
userId	string	percorso	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