Questo articolo spiega come configurare l'importazione e la sincronizzazione di utenti e gruppi in SMARTFENSE interrogando un'API esterna. Descrive la configurazione della connessione, il mapping delle chiavi JSON, le regole di creazione e aggiornamento e la gestione di maiuscole e campi vuoti.
La configurazione è disponibile in Utenti e gruppi > Importazione e sincronizzazione > Da API.
Prerequisiti
- Un'API esterna accessibile che restituisca i dati degli utenti in formato JSON.
- Token di autenticazione valido per quell'API.
- Accesso amministrativo all'istanza SMARTFENSE.
Connessione con l'API
Compilare i seguenti campi affinché SMARTFENSE possa interrogare l'API:
- URL dell'API: indirizzo a cui SMARTFENSE invia la richiesta.
- Token di autenticazione: token di accesso corrispondente.
Corrispondenza tra campi
Questa sezione consente di mappare i campi di SMARTFENSE con le chiavi JSON restituite dalla vostra API.
Esempio di mapping
Se l'API restituisce la chiave user-id e si desidera utilizzarla come nome utente, impostare la corrispondenza tra il campo username di SMARTFENSE e la chiave user-id dell'API.
Le chiavi vanno inserite senza virgolette.
Campi obbligatori
I seguenti campi sono obbligatori:
- Nome
- Cognome
Gli altri campi sono opzionali.
Quando viene creato o modificato un utente
- Se un utente presente nella risposta dell'API non esiste in SMARTFENSE, verrà creato.
- Se esiste già, verrà aggiornato.
L'identificazione avviene tramite il nome utente specificato nella risposta dell'API. Se non è specificato, la piattaforma utilizza la prima parte dell'email (la parte prima di @).
Non è possibile modificare il nome utente né l'indirizzo email di un utente esistente tramite questa funzionalità.
Uso delle maiuscole
Nomi utente
SMARTFENSE non distingue tra maiuscole e minuscole per determinare se un utente esiste. Quando si crea un nuovo utente, si rispetta il formato restituito dall'API.
Gruppi
Nei gruppi, aree funzionali e livelli gerarchici le maiuscole sono considerate. Se l'API restituisce nomi senza corrispondenza esatta, viene effettuata una seconda ricerca ignorando le maiuscole.
Altri casi rilevanti
- L'email viene sempre memorizzata in minuscolo.
- Nome e cognome vengono formattati con la lettera maiuscola iniziale di ogni parola.
- L'UPN rispetta il formato esatto restituito dall'API.
Comportamento in caso di campi vuoti
| Campo | Comportamento se assente nella risposta |
|---|---|
| Lingua | I nuovi utenti assumono quella dell'amministratore che importa. Gli utenti esistenti mantengono quella attuale. |
| Nome utente | Viene generato dalla prima parte dell'email. |
| Senza email, l'utente non può essere importato. | |
| Stato | I nuovi utenti vengono creati come Attivi. Gli utenti esistenti mantengono quello attuale. |
| Ruolo | I nuovi utenti vengono creati come Utente finale. Gli utenti esistenti mantengono quello attuale. |
| Telefono, ID dipendente, UPN | Rimangono vuoti. |
Aiuto in linea
Ogni campo nella schermata include un'icona (i) a destra. Posizionando il cursore sull'icona, si apre una finestra popup con l'aiuto specifico per quel campo.
💡 Best practice
- Verificare che l'API restituisca sempre Nome, Cognome e Email, poiché sono obbligatori.
- Definire chiaramente il mapping delle chiavi JSON prima di abilitare la sincronizzazione automatica.
- Mantenere coerenza nei nomi dei gruppi per evitare duplicati dovuti a maiuscole e minuscole.
- Testare l'integrazione in un ambiente controllato prima di sincronizzare gli utenti in produzione.
- Ruotare periodicamente il token di autenticazione e aggiornarlo in SMARTFENSE per evitare interruzioni del servizio.