Argomento
Questo articolo fornisce istruzioni su come utilizzare gli endpoint API per creare, aggiornare ed eliminare gli utenti finali e i tecnici NinjaOne.
Ambiente
API pubblica NinjaOne
Descrizione
- Note
- Creare utenti finali e tecnici tramite API
- Modifica degli utenti finali e dei tecnici tramite API
- Eliminazione di utenti finali e tecnici tramite API
- Risorse aggiuntive
Note
- I tecnici creati tramite API ricevono un'e-mail di registrazione per impostazione predefinita.
- Gli utenti finali creati tramite API non ricevono un'e-mail di registrazione per impostazione predefinita
- È possibile filtrare la dashboard degli utenti finali in base a "Invito e-mail" in Altri filtri per trovare gli stati in sospeso, scaduti e registrati. È possibile utilizzare l'azione "Invia nuovamente invito" per inviare l'e-mail di registrazione a uno o più utenti.
- Non è possibile eliminare o modificare i nomi degli utenti finali aggiunti tramite System for Cross-domain Identity Management (SCIM), ma è possibile aggiungere o rimuovere ruoli e organizzazioni (se l'organizzazione non è gestita tramite SCIM).
- Se non si specifica un'organizzazione durante la creazione dell'utente finale, NinjaOne concederà all'utente l'accesso a tutte le organizzazioni.
- Non è possibile eliminare tecnici o amministratori di sistema tramite l'API.
- Per un elenco degli endpoint, consultare la documentazione dell'API pubblica disponibile nella sezione Risorse di aiuto (nell'angolo in alto a destra della piattaforma NinjaOne).
Creare utenti finali e tecnici tramite API
Quando si creano nuovi utenti, è necessario includere i seguenti dati:
- Tipo di utente (utente finale, tecnico o contatto)
- Nome
- Cognome
- Indirizzo e-mail
È possibile includere facoltativamente i seguenti dati:
- Numero
- Ruolo (solo per gli utenti finali)
- Organizzazione (solo per utenti finali e contatti)
Modifica utenti finali e tecnici tramite API
È possibile modificare i seguenti campi tramite API:
- Nome (modifica)
- Cognome (modifica)
- Ruoli (rimuovi o aggiungi solo per gli utenti finali)
- Organizzazione (modifica solo per gli utenti finali)
Modificando l'organizzazione in
" " l'utente non sarà associato ad alcuna organizzazione.Eliminare utenti finali e tecnici tramite API
Per eliminare un utente finale o un tecnico, fornire l'ID.
Esempio: Creare un utente finale
L'esempio seguente mostra la richiesta e la risposta per l'endpoint (POST) /api/v2/user/end-users.
Richiesta
{
"firstName": "Pete",
"lastName": "Birk",
"email": "[email protected]",
"phone": "+15121234567",
"organizationId": 5,
"fullPortalAccess": true
}Risposta
{
"id": 43,
"uid": "exxxaad6-xxe6-4fxx-b67b-bexxxc51c77x",
"firstName": "Utente",
"lastName": "Nome",
"email": "[email protected]",
"phone": "+15121234567",
"enabled": true,
"mustChangePw": false,
"mfaConfigured": true,
"userType": "END_USER",
"invitationStatus": "REGISTERED",
"organizationId": 5,
"assignedDeviceIds": null
"deviceIds": null,
"fullPortalAccess": true
"authType": "SSO",
"scimUser": false
}