In questa pagina

> risorse > documentazione > api > Riferimento API: tenant

Riferimento API: tenant

Recuperare le informazioni sul tenant

Endpoint: GET /v1/tenant/{tenantId}

Autenticazione: Chiave API associata al tenant · ambito read

Parametri:

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

Risposta (200):

Dettagli del 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"
}

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:

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

Aggiornare le impostazioni del tenant

Endpoint: PUT /v1/tenant/{tenantId}

Autenticazione: Chiave API associata al tenant · ambito write

Parametri:

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

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
id	string	No	Formato: `uuid`
displayName	string	No
contactEmail	string	No
shortName	string	No
description	string	No

Risposta (200):

Tenant aggiornato

{
	"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, un’espressione di filtro non valida, un processo senza modello, un formato 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 perché il nome breve è riservato o già utilizzato

Ottenere le statistiche del Tenant (dimensione dei dati, modelli, simulazioni, utenti)

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

Autenticazione: Chiave API con ambito Tenant · ambito read

Parametri:

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

Risposta (200):

Statistiche del Tenant

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

Campo	Tipo	Obbligatorio	Descrizione
tenantId	string	Sì	Formato: `uuid`
uploadedDataSize	number	Sì
uploadedDataCount	number	Sì
modelCount	number	Sì
simulationCount	number	Sì
userCount	number	Sì

Errori:

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

Elencare gli utenti del Tenant

Restituisce gli utenti corrispondenti come array JSON semplice: non viene fornito il conteggio totale; per la paginazione, utilizzare limit/offset.

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

Autenticazione: Chiave API con ambito Tenant · 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

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

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta

Aggiungere un utente al Tenant (non viene inviata alcuna e-mail di invito)

I campi dei ruoli nel corpo della richiesta (isAdminInTenant, access: none|portalViewer|designer|architect|intelligence, isDashboardViewer) vengono applicati esattamente come specificati. Questo endpoint consente l’amministrazione completa del Tenant, quindi le chiavi con autorizzazioni di scrittura devono essere rilasciate solo a chiamanti fidati. L’accesso in sola lettura alle Dashboard è gestito dal valore booleano isDashboardViewer; il precedente livello di accesso in sola lettura per i visualizzatori è stato rimosso.

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

Autenticazione: Chiave API con ambito Tenant · ambito write

Parametri:

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

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
email	string	Sì	Indirizzo e-mail dell’utente (utilizzato anche per l’accesso) Formato: `email`
firstName	string	No	Nome facoltativo Lunghezza massima: 64
lastName	string	No	Cognome facoltativo Lunghezza massima: 64
isActiveInTenant	boolean	No	Indica se l’utente è attivo in questo tenant
isAdminInTenant	boolean	No	Diritti di amministratore in questo tenant (applicati senza modifiche: accesso completo alle funzioni di amministrazione del tenant)
access	`none` \| `portalViewer` \| `designer` \| `architect` \| `intelligence`	No	Postazione selezionabile singolarmente: nessuna \| portalViewer \| designer \| architect \| intelligence Valori consentiti: `none`, `portalViewer`, `designer`, `architect`, `intelligence`
isDashboardViewer	boolean	No	Indica se l’utente dispone dell’accesso in sola lettura alle Dashboard
preferredLocale	`en` \| `zh` \| `es` \| `fr` \| `de` \| `pt` \| `it` \| `nl` \| `ja` \| `tr` \| `pl` \| `cs` \| `hu` \| `id` \| `ko` \| `vi` \| `th`	No	Lingua preferita dell’interfaccia per l’utente Valori consentiti: `en`, `zh`, `es`, `fr`, `de`, `pt`, `it`, `nl`, `ja`, `tr`, `pl`, `cs`, `hu`, `id`, `ko`, `vi`, `th`

Risposta (201):

Utente aggiunto

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

Campo	Tipo	Obbligatorio	Descrizione
id	string	Sì	ID del nuovo utente aggiunto
message	string	Sì

Errori:

401 Chiave API mancante, non valida, disabilitata o scaduta
409 La richiesta è in conflitto con lo stato attuale, ad esempio per un limite di postazioni o per un ID già utilizzato

Modificare le impostazioni di un utente nel Tenant

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

Autenticazione: Chiave API con ambito Tenant · ambito write

Parametri:

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

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
isActiveInTenant	boolean	No	Indica se l’utente è attivo in questo Tenant
isAdminInTenant	boolean	No	Diritti di amministrazione in questo Tenant (applicati esattamente come specificati: accesso completo all’amministrazione del Tenant)
access	`none` \| `portalViewer` \| `designer` \| `architect` \| `intelligence`	No	Postazione selezionabile singolarmente: none \| portalViewer \| designer \| architect \| intelligence. L’accesso in visualizzazione alle Dashboard è gestito dal valore booleano isDashboardViewer. Valori consentiti: `none`, `portalViewer`, `designer`, `architect`, `intelligence`
isDashboardViewer	boolean	No	Indica se l’utente può visualizzare le Dashboard in sola lettura

Risposta (200):

Aggiornato

{
	"message": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
message	string	Sì

Errori:

400 Richiesta non valida: ad esempio, un’espressione di filtro non valida, un processo senza modello, un formato di caricamento non supportato o un campo obbligatorio mancante
401 Chiave API mancante, non valida, disabilitata o scaduta
404 Risorsa non trovata

Rimuovere un utente dal Tenant

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

Autenticazione: Chiave API con ambito Tenant · 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:

400 Richiesta non valida: ad esempio, un’espressione di filtro non valida, un processo senza modello, un formato di caricamento non supportato o un campo obbligatorio mancante
401 Chiave API mancante, non valida, disabilitata o scaduta
404 Risorsa non trovata

Generare un token monouso per consentire a un utente di accedere

Restituisce un token monouso (validità di 60 secondi) associato all’utente, al Tenant e all’organizzazione, insieme all’url a cui indirizzare il browser dell’utente. Aprendo l’URL nel browser, l’utente accede a ProcessMind senza ulteriori passaggi: non serve un link e-mail né si accede impersonando l’utente, che dispone di una sessione personale. È necessario che la Chiave API disponga dell’ambito dedicato sessions: una chiave con ambito organizzazione può generare token per qualsiasi Tenant della propria organizzazione, mentre una chiave con ambito Tenant può farlo solo per gli utenti del proprio Tenant. Il token va trattato come una password: viene restituito una sola volta, non viene mai registrato nei log e può essere revocato disabilitando la chiave o l’utente.

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

Autenticazione: Chiave API con ambito Tenant o organizzazione · ambito sessions · limite di frequenza: 2 richieste/s (picco di 4)

Parametri:

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

Corpo della richiesta:

Percorso di destinazione facoltativo (percorso relativo nell’app, ad esempio “app” o “app/dashboards”)

{
	"path": "string"
}

Campo	Tipo	Obbligatorio	Descrizione
path	string	No	Lunghezza massima: 512

Risposta (200):

Token di accesso

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

Campo	Tipo	Obbligatorio	Descrizione
token	string	Sì
url	string	Sì
expiresInSeconds	number	Sì
expiresAt	string	Sì	Formato: `date-time`

Errori:

400 Richiesta non valida: ad esempio, un’espressione di filtro non valida, un processo senza modello, un formato 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
429 Limite di richieste superato: consultare il limite di frequenza documentato per l’endpoint

Le Chiavi API consentono di autenticare le integrazioni. Le chiavi con ambito organizzazione possono creare e gestire le chiavi di qualsiasi Tenant dell’organizzazione.

Elencare le Chiavi API del Tenant

È necessaria una Chiave API con ambito organizzazione. Il segreto non viene mai restituito.

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

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 delle Chiavi 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
		}
	}
]

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

Creare una Chiave API con ambito Tenant

È necessaria una Chiave API di scrittura con ambito organizzazione. Il segreto viene generato dal server e restituito una sola volta nella risposta: lo conservi in modo sicuro. Viene memorizzato solo il relativo hash.

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

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",
	"scope": {
		"read": true,
		"write": true,
		"uploadData": true,
		"sessions": true
	},
	"enabled": true,
	"expiresAt": "2024-03-15T16:30:00Z"
}

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	Sì	Lunghezza massima: 128
scope	object	No
enabled	boolean	No
expiresAt	string	No	Formato: `date-time`

Risposta (201):

Chiave API creata (include il segreto monouso)

{
	"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	Obbligatorio	Descrizione
id	string	Sì	Formato: `uuid`
tenantId	string	Sì	Formato: `uuid`
organizationId	string	Sì	Formato: `uuid`
displayName	string	Sì	Lunghezza massima: 128
partialKey	string	Sì	Lunghezza massima: 128
enabled	boolean	Sì	Predefinito: `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ì	Lunghezza massima: 128

Errori:

400 Richiesta non valida: ad esempio, un’espressione di filtro non valida, un processo senza modello, un formato 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

Modificare una Chiave API con ambito Tenant

È necessaria una Chiave API di scrittura con ambito organizzazione. I campi dell’ambito vengono uniti a quelli già memorizzati.

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

Autenticazione: Chiave API con ambito organizzazione · ambito write

Parametri:

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

Corpo della richiesta:

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

Campo	Tipo	Obbligatorio	Descrizione
displayName	string	No	Lunghezza massima: 128
scope	object	No
enabled	boolean	No
expiresAt	string	No	Formato: `date-time`

Risposta (200):

Chiave API aggiornata

{
	"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	Obbligatorio	Descrizione
id	string	Sì	Formato: `uuid`
tenantId	string	Sì	Formato: `uuid`
organizationId	string	Sì	Formato: `uuid`
displayName	string	Sì	Lunghezza massima: 128
partialKey	string	Sì	Lunghezza massima: 128
enabled	boolean	Sì	Predefinito: `true`
createdAt	string	Sì	Formato: `date-time`
lastUsedAt	string	Sì	Formato: `date-time`
expiresAt	string	Sì	Formato: `date-time`
scope	object	Sì

Errori:

400 Richiesta non valida: ad esempio, un’espressione di filtro non valida, un processo senza modello, un formato 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

Eliminare una Chiave API con ambito Tenant

È necessaria una Chiave API di scrittura con ambito organizzazione. La chiave viene eliminata logicamente e smette immediatamente di autenticare le richieste.

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

Autenticazione: Chiave API con ambito organizzazione · ambito write

Parametri:

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

Risposta (200):

Chiave API eliminata

{
	"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

Documentazione correlata

Riferimento API: organizzazioni

Riferimento API per gli endpoint di gestione delle organizzazioni e degli utenti.

Documentazione di riferimento dell’API: dati

Documentazione di riferimento dell’API per gli endpoint di gestione di dataset e tabelle dati.

Riferimento API: processi

Riferimento API per gli endpoint di gestione dei processi e mappatura dei dati.

Riferimento API: simulazioni

Riferimento API per gli endpoint di gestione delle simulazioni e generazione assistita dall’AI.

Progettazione. Analisi. Miglioramento. Costruisca un’architettura dei processi integrata e mantenga il controllo.

Acceda subito, senza carta di credito né attese. Trasformi il modo in cui opera la Sua organizzazione in una progettazione dei processi chiara e interconnessa.

Definisca l’architettura dei processi, le responsabilità e i controlli, e allinei ruoli e compiti a ogni livello.

Inizi la prova gratuita e crei una base affidabile per governare, gestire e migliorare costantemente i processi della Sua organizzazione.

Inizi ora la prova gratuita