Riferimento API: Organization
Endpoint Organization
Le organization raggruppano più tenant in un’unica entità.
Ottieni Dettagli Organization
Recupera le informazioni sull’organization a cui appartiene un tenant.
Endpoint: GET /tenant/{tenantId}/organization
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | Identificativo univoco del tenant |
Risposta:
{
"id": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"displayName": "Acme Corporation",
"createdAt": "2023-06-01T00:00:00Z"
}
Ottieni Statistiche Organization
Recupera statistiche aggregate di tutta l’organizzazione.
Endpoint: GET /tenant/{tenantId}/organization/statistics
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | Identificativo univoco del tenant |
Risposta:
{
"tenantCount": 5,
"totalProcessCount": 42,
"totalDatasetCount": 18,
"totalUserCount": 25,
"totalStorageUsedBytes": 5368709120
}
Elenco Tenant Organization
Recupera tutti i tenant dell’organizzazione.
Endpoint: GET /tenant/{tenantId}/organization/tenants
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | Identificativo univoco del tenant |
Risposta:
[
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"displayName": "Sales Department",
"createdAt": "2024-01-01T00:00:00Z"
},
{
"id": "d4e5f6a7-b8c9-0123-def4-567890123456",
"displayName": "Operations",
"createdAt": "2024-02-15T00:00:00Z"
}
]
Crea Tenant
Crea un nuovo tenant nell’organizzazione.
Endpoint: POST /tenant/{tenantId}/organization/tenants
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | Identificativo univoco di un tenant esistente nell’organizzazione |
Request Body:
{
"shortName": "sales-team",
"displayName": "Sales Team",
"description": "Tenant per il dipartimento sales"
}
| Campo | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| shortName | string | Sì | Identificativo compatibile per URL (minuscolo, trattini ammessi) |
| displayName | string | No | Nome leggibile del tenant |
| description | string | No | Descrizione del tenant |
Risposta: Restituisce il tenant creato.
Elimina Tenant
Elimina un tenant dall’organizzazione.
Endpoint: DELETE /tenant/{tenantId}/organization/tenants/{targetTenantId}
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | Identificativo univoco di un tenant esistente nell’organizzazione |
| targetTenantId | string | path | Sì | Identificativo univoco del tenant da eliminare |
Risposta:
{
"success": true
}
warning
L’eliminazione di un tenant rimuoverà in modo permanente tutti i processi, dataset e gli utenti associati. Questa azione non può essere annullata. Non è possibile eliminare il tenant con cui si sta effettuando l’accesso.
Endpoint Utenti Organization
Elenco Utenti Organization
Recupera tutti gli utenti dell’organizzazione.
Endpoint: GET /tenant/{tenantId}/organization/users
Parametri:
| Nome | Tipo | Posizione | Obbligatorio | Descrizione |
|---|---|---|---|---|
| tenantId | string | path | Sì | Identificativo univoco del tenant |
Risposta:
[
{
"id": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"email": "admin@example.com",
"firstName": "Jane",
"lastName": "Smith",
"createdAt": "2023-06-01T00:00:00Z",
"lastLoginAt": "2024-03-01T10:00:00Z",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": true
}
]
Aggiorna Utente Organization
Aggiorna i permessi di un utente nell’organizzazione.
Endpoint: PUT /tenant/{tenantId}/organization/users
Request Body:
{
"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
"isActiveInOrganization": true,
"isAdminInOrganization": true
}
| Campo | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| userId | string | Sì | Identificativo univoco dell’utente |
| organizationId | string | Sì | Identificativo univoco dell’organizzazione |
| isActiveInOrganization | boolean | No | Se l’utente è attivo nell’organizzazione |
| isAdminInOrganization | boolean | No | Se l’utente ha privilegi admin nell’organizzazione |
Risposta:
{
"message": "Impostazioni utente organizzazione aggiornate."
}
Rimuovi Utente Organization
Rimuove completamente un utente dall’organizzazione.
Endpoint: DELETE /tenant/{tenantId}/organization/users
Request Body:
{
"userId": "e5f6a7b8-c9d0-1234-efa5-678901234567",
"organizationId": "c3d4e5f6-a7b8-9012-cdef-345678901234"
}
| Campo | Tipo | Obbligatorio | Descrizione |
|---|---|---|---|
| userId | string | Sì | Identificativo univoco dell’utente da rimuovere |
| organizationId | string | Sì | Identificativo univoco dell’organizzazione |
Risposta:
{
"message": "Utente rimosso dall'organizzazione."
}
warning
La rimozione di un utente dall’organizzazione ne revocherà l’accesso a tutti i tenant dell’organizzazione.