Tema
Este artículo proporciona instrucciones para utilizar los puntos finales de la API para crear, actualizar y eliminar usuarios finales y técnicos de NinjaOne.
Entorno
API pública de NinjaOne
Descripción
- Notas
- Crear usuarios finales y técnicos a través de la API
- Editar usuarios finales y técnicos a través de la API
- Eliminar usuarios finales y técnicos a través de la API
- Recursos adicionales
Notas importantes
- Los técnicos creados a través de la API reciben un correo electrónico de registro de forma predeterminada.
- Los usuarios finales creados a través de la API no reciben un correo electrónico de registro de forma predeterminada
- Puede filtrar el panel de control de usuarios finales por «Invitación por correo electrónico» en Más filtros para encontrar los estados pendientes, caducados y registrados. Puede utilizar la acción «Reenviar invitación» para enviar el correo electrónico de registro a uno o varios usuarios.
- No puede eliminar ni modificar los nombres de los usuarios finales añadidos a través del Sistema de gestión de identidades entre dominios (SCIM), pero puede añadir o eliminar roles y organizaciones (si la organización no se gestiona a través de SCIM).
- Si no se especifica una organización al crear el usuario final, NinjaOne le dará acceso a todas las organizaciones.
- No se pueden eliminar técnicos ni administradores del sistema a través de la API.
- Para obtener una lista de puntos finales, consulte la documentación de la API pública que se encuentra en Recursos de ayuda (en la esquina superior derecha de la plataforma NinjaOne).
Crear usuarios finales y técnicos a través de la API
Debe incluir los siguientes datos al crear nuevos usuarios:
- Tipo de usuario (usuario final, técnico o contacto)
- Nombre
- Apellidos
- Dirección de correo electrónico
Opcionalmente, puede incluir los siguientes datos:
- Número de teléfono
- Función (solo para usuarios finales)
- Organización (solo para usuarios finales y contactos)
Editar usuarios finales y técnicos a través de la API
Puede modificar los siguientes campos a través de la API:
- Nombre (cambiar)
- Apellidos (cambiar)
- Roles (eliminar o añadir solo para usuarios finales)
- Organización (cambiar solo para usuarios finales)
Si cambia la organización a
« », el usuario dejará de estar asociado a ninguna organización. Eliminar usuarios finales y técnicos a través de la API
Para eliminar un usuario final o un técnico, proporcione el ID.
Ejemplo: Crear usuario final
El siguiente ejemplo muestra la solicitud y la respuesta para el punto final (POST) /api/v2/user/end-users.
Solicitud
{
"firstName": "Pete",
"lastName": "Birk",
"email": "[email protected]",
"phone": "+15121234567",
"organizationId": 5,
"fullPortalAccess": true
}Respuesta
{
"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
}