Informations de référence sur l’API de gestion des mots de passe et de l’authentification pour les capteurs de monitoring OT

Cet article liste les API de gestion des mots de passe et de l’authentification prises en charge pour les capteurs OT Defender pour IoT.

set_password (Modifier votre mot de passe)

Utilisez cette API pour permettre aux utilisateurs de modifier leur mot de passe.

Vous n’avez pas besoin d’un jeton d’accès Defender pour IoT pour utiliser cette API.

URI : /external/authentication/set_password

POST

Requête

Type : JSON

Exemple :

request:

{
    "username": "test",
    "password": "Test12345\!",
    "new_password": "Test54321\!"
}

Paramètres de la demande

Nom	Type	Obligatoire/facultatif
username	String	Obligatoire
mot de passe	String	Obligatoire
new_password	String	Obligatoire

Réponse

Type : JSON

Chaîne de message avec les détails de l’état de l’opération :

Message	Description
Réussite – message	Le mot de passe a été remplacé
Échec – erreur	Échec d'authentification de l’utilisateur
Échec – erreur	Le mot de passe ne respecte pas la stratégie de sécurité

Exemple :

response:

{
    "error": {
        "userDisplayErrorMessage": "User authentication failure"
    }
}

Commande cURL

Type : 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

Exemple :

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 (Mettre à jour un mot de passe utilisateur par administrateur)

Utilisez cette API pour permettre aux administrateurs système de modifier les mots de passe des utilisateurs spécifiés. Tous les rôles d’utilisateur Administrateur Defender pour IoT peuvent fonctionner avec l’API.

Vous n’avez pas besoin d’un jeton d’accès Defender pour IoT pour utiliser cette API.

URI : /external/authentication/set_password_by_admin

POST

Requête

Type : JSON

Exemple de requête

request:

{
    "admin_username": "admin",
    "admin_password: "Test0987"
    "username": "test",
    "new_password": "Test54321\!"
}

Paramètres de la demande

Nom	Type	Obligatoire/facultatif
admin_username	String	Obligatoire
admin_password	String	Obligatoire
username	String	Obligatoire
new_password	String	Obligatoire

Réponse

Type : JSON

Chaîne de message avec les détails de l’état de l’opération :

Message	Description
Réussite – message	Le mot de passe a été remplacé
Échec – erreur	Échec d'authentification de l’utilisateur
Échec – erreur	L'utilisateur n'existe pas
Échec – erreur	Le mot de passe ne respecte pas la stratégie de sécurité
Échec – erreur	L'utilisateur n'a pas l'autorisation de changer de mot de passe

Exemple de réponse

response:

{
    "error": {
        "userDisplayErrorMessage": "The user 'test_user' doesn't exist",
        "internalSystemErrorMessage": "The user 'test_user' doesn't exist"
    }
}

Commande cURL

Type : 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

Exemple :

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 (valider des informations d’identification utilisateur)

Utilisez cette API pour valider un nom d’utilisateur et un mot de passe Defender pour IoT.

Vous n’avez pas besoin d’un jeton d’accès Defender pour IoT pour utiliser cette API.

URI : /api/external/authentication/validation

POST

Requête

Type de demande : JSON

Paramètres de requête

Nom	Type	Obligatoire/facultatif
username	String	Obligatoire
mot de passe	String	Obligatoire

Exemple de demande :

request:
{
    "username": "test",
    "password": "Test12345\!"
}

Réponse

Type : JSON

Chaîne de message avec les détails de l’état de l’opération :

Message	Description
Réussite – message	Authentification réussie
Échec – erreur	Échec de la validation des informations d’identification

Exemple de réponse

response:
{
    "msg": "Authentication succeeded."
}

Commande cURL

Type : 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

Exemple :

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

Étapes suivantes

Pour plus d’informations, consultez Vue d’ensemble de référence de l’API Defender pour IoT.