Sujet
Cet article fournit des instructions sur l'utilisation des points de terminaison API pour créer, mettre à jour et supprimer vos utilisateurs finaux et techniciens NinjaOne.
Environnement
API publique NinjaOne
Description
- Remarques
- Créer des utilisateurs finaux et des techniciens via l'API
- Modifier les utilisateurs finaux et les techniciens via l'API
- Supprimer des utilisateurs finaux et des techniciens via l'API
- Ressources supplémentaires
Remarques importantes
- Les techniciens créés via l'API reçoivent un e-mail d'inscription par défaut.
- Les utilisateurs finaux créés via l'API ne reçoivent pas d'e-mail d'inscription par défaut
- Vous pouvez filtrer le tableau de bord des utilisateurs finaux par « Invitation par e-mail » sous Plus de filtres pour trouver les statuts en attente, expirés et enregistrés. Vous pouvez utiliser l'action « Renvoyer l'invitation » pour envoyer l'e-mail d'inscription à un ou plusieurs utilisateurs.
- Vous ne pouvez pas supprimer ou modifier les noms des utilisateurs finaux ajoutés via le système de gestion des identités interdomaines (SCIM), mais vous pouvez ajouter ou supprimer des rôles et des organisations (si l'organisation n'est pas gérée via SCIM).
- Si vous ne spécifiez pas d'organisation lors de la création de l'utilisateur final, NinjaOne donnera à l'utilisateur l'accès à toutes les organisations.
- Vous ne pouvez pas supprimer de techniciens ou d'administrateurs système via l'API.
- Pour obtenir la liste des points de terminaison, consultez la documentation de l'API publique située dans les ressources d'aide (dans le coin supérieur droit de la plateforme NinjaOne).
Créer des utilisateurs finaux et des techniciens via l'API
Vous devez inclure les données suivantes lors de la création de nouveaux utilisateurs :
- Type d'utilisateur (utilisateur final, technicien ou contact)
- Prénom
- Nom
- Adresse
Vous pouvez également inclure les informations suivantes :
- Numéro
- Fonction (uniquement pour les utilisateurs finaux)
- Organisation (uniquement pour les utilisateurs finaux et les contacts)
Modifier les utilisateurs finaux et les techniciens via l'API
Vous pouvez modifier les champs suivants via l'API :
- Prénom (modifier)
- Nom (modifier)
- Rôles (supprimer ou ajouter uniquement pour les utilisateurs finaux)
- Organisation (modifier uniquement pour les utilisateurs finaux)
Si vous remplacez le nom de l'organisation par
« », l'utilisateur ne sera associé à aucune organisation.Supprimer les utilisateurs finaux et les techniciens via l'API
Pour supprimer un utilisateur final ou un technicien, indiquez son ID.
Exemple : créer un utilisateur final
L'exemple suivant montre la requête et la réponse pour le point de terminaison (POST) /api/v2/user/end-users.
Demande
{
"firstName": "Pete",
"lastName": "Birk",
"email": "[email protected]",
"phone": "+15121234567",
"organizationId": 5,
"fullPortalAccess": true
}Réponse
{
"id": 43,
"uid": "exxxaad6-xxe6-4fxx-b67b-bexxxc51c77x",
"firstName": "User",
"lastName": "Name",
"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
}