Referencia de la API de autenticación y administración de contraseñas para sensores de supervisión de OT
Artículo 04/11/2023
2 colaboradores
Comentarios
En este artículo
En este artículo se enumeran las API de autenticación y administración de contraseñas compatibles con los sensores de OT de Defender para IoT.
set_password (cambio de contraseña)
Use esta API para que los usuarios puedan cambiar sus contraseñas.
No necesita un token de acceso de Defender para IoT para usar esta API.
URI: /external/authentication/set_password
POST
Tipo: JSON
Ejemplo :
request:
{
"username": "test",
"password": "Test12345\!",
"new_password": "Test54321\!"
}
Parámetros de solicitud
Nombre
Tipo
Obligatorio u opcional
username
String
Obligatorio
password
String
Obligatorio
new_password
String
Obligatorio
Tipo: JSON
Cadena de mensaje con los detalles del estado de la operación:
Message
Descripción
Success – msg
se ha reemplazado la contraseña
Failure – error
error de autenticación del usuario
Failure – error
la contraseña no coincide con la directiva de seguridad
Ejemplo :
response:
{
"error": {
"userDisplayErrorMessage": "User authentication failure"
}
}
Tipo: POST
API :
curl -k -X POST -d '{"username": "<USER_NAME>","password": "<CURRENT_PASSWORD>","new_password": "<NEW_PASSWORD>"}' -H 'Content-Type: application/json' https://<IP_ADDRESS>/api/external/authentication/set_password
Ejemplo :
curl -k -X POST -d '{"username": "myUser","password": "1234@abcd","new_password": "abcd@1234"}' -H 'Content-Type: application/json' https://127.0.0.1/api/external/authentication/set_password
set_password_by_admin (actualización de la contraseña de un usuario por el administrador)
Use esta API para que los administradores del sistema puedan cambiar las contraseñas de usuarios especificados. Los roles de usuario administrador de Defender para IoT pueden funcionar con la API.
No necesita un token de acceso de Defender para IoT para usar esta API.
URI: /external/authentication/set_password_by_admin
POST
Tipo: JSON
Ejemplo de solicitud
request:
{
"admin_username": "admin",
"admin_password: "Test0987"
"username": "test",
"new_password": "Test54321\!"
}
Parámetros de solicitud
Nombre
Tipo
Obligatorio u opcional
admin_username
String
Obligatorio
admin_password
String
Obligatorio
username
String
Obligatorio
new_password
String
Obligatorio
Tipo: JSON
Cadena de mensaje con los detalles del estado de la operación:
Message
Descripción
Success – msg
se ha reemplazado la contraseña
Failure – error
error de autenticación del usuario
Failure – error
el usuario no existe
Failure – error
la contraseña no coincide con la directiva de seguridad
Failure – error
el usuario no tiene los permisos para cambiar la contraseña
Ejemplo de respuesta
response:
{
"error": {
"userDisplayErrorMessage": "The user 'test_user' doesn't exist",
"internalSystemErrorMessage": "The user 'test_user' doesn't exist"
}
}
Tipo: POST
API :
curl -k -X POST -d '{"admin_username":"<ADMIN_USERNAME>","admin_password":"<ADMIN_PASSWORD>","username": "<USER_NAME>","new_password": "<NEW_PASSWORD>"}' -H 'Content-Type: application/json' https://<IP_ADDRESS>/api/external/authentication/set_password_by_admin
Ejemplo :
curl -k -X POST -d '{"admin_user":"adminUser","admin_password": "1234@abcd","username": "myUser","new_password": "abcd@1234"}' -H 'Content-Type: application/json' https://127.0.0.1/api/external/authentication/set_password_by_admin
validation (validación de las credenciales del usuario)
Use esta API para validar el nombre de usuario y contraseña de Defender para IoT.
No necesita un token de acceso de Defender para IoT para usar esta API.
URI: /api/external/authentication/validation
POST
Tipo de solicitud : JSON
Parámetros de consulta
Nombre
Tipo
Obligatorio/opcional
username
String
Obligatorio
password
String
Obligatorio
Ejemplo de solicitud:
request:
{
"username": "test",
"password": "Test12345\!"
}
Tipo: JSON
Cadena de mensaje con los detalles del estado de la operación:
Message
Descripción
Success - msg
Autenticación correcta
Failure - error
Error en la validación de credenciales
Ejemplo de respuesta
response:
{
"msg": "Authentication succeeded."
}
Tipo: POST
API :
curl -k -X POST -H "Authorization: <AUTH_TOKEN>" -H "Content-Type: application/json" -d '{"username": <USER NAME>, "password": <PASSWORD>}' https://<IP_ADDRESS>/api/external/authentication/validation
Ejemplo :
curl -k -X POST -H "Authorization: 1234b734a9244d54ab8d40aedddcabcd" -H "Content-Type: application/json" -d '{"username": "test", "password": "test"}' https://127.0.0.1/api/external/authentication/validation
Pasos siguientes
Para obtener más información, consulte la información general de referencia de API de Defender para IoT .