Referenz zu APIs für Authentifizierung und Kennwortverwaltung für OT-Überwachungssensoren

In diesem Artikel werden die Authentifizierungs- und Kennwortverwaltungs-APIs aufgeführt, die für OT-Sensoren in Defender for IoT unterstützt werden.

set_password (Ihr Kennwort ändern)

Mit dieser API können Sie Benutzern ermöglichen, ihre eigenen Kennwörter zu ändern.

Zum Verwenden dieser API benötigen Sie kein Defender für IoT-Zugriffstoken.

URI: /external/authentication/set_password

POST

Anforderung

Typ: JSON

Beispiel:

request:

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

Anforderungsparameter

Name	Typ	Erforderlich/optional
username	String	Erforderlich
password	String	Erforderlich
new_password	String	Erforderlich

Antwort

Typ: JSON

Meldungszeichenfolge mit Details zum Vorgangsstatus:

`Message`	BESCHREIBUNG
Erfolg: msg	Das Kennwort wurde ersetzt
Fehler: error	Fehler bei der Benutzerauthentifizierung
Fehler: error	Das Kennwort entspricht nicht der Sicherheitsrichtlinie

Beispiel:

response:

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

cURL-Befehl

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

Beispiel:

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 (Ein Benutzerkennwort durch den Administrator aktualisieren)

Mit dieser API können Sie Systemadministratoren ermöglichen, die Kennwörter für bestimmte Benutzer zu ändern. Defender für IoT-Administratorrollen können mit der API arbeiten.

Zum Verwenden dieser API benötigen Sie kein Defender für IoT-Zugriffstoken.

URI: /external/authentication/set_password_by_admin

POST

Anforderung

Typ: JSON

Anforderungsbeispiel

request:

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

Anforderungsparameter

Name	Typ	Erforderlich/optional
admin_username	String	Erforderlich
admin_password	String	Erforderlich
username	String	Erforderlich
new_password	String	Erforderlich

Antwort

Typ: JSON

Meldungszeichenfolge mit Details zum Vorgangsstatus:

`Message`	BESCHREIBUNG
Erfolg: msg	Das Kennwort wurde ersetzt
Fehler: error	Fehler bei der Benutzerauthentifizierung
Fehler: error	Benutzer ist nicht vorhanden
Fehler: error	Das Kennwort entspricht nicht der Sicherheitsrichtlinie
Fehler: error	Der Benutzer hat keine Berechtigung zum Ändern des Kennworts

Antwortbeispiel

response:

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

cURL-Befehl

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

Beispiel:

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 (Benutzeranmeldeinformationen überprüfen)

Mit dieser API können Sie einen Namen und das Kennwort eines Benutzers von Defender für IoT überprüfen.

Zum Verwenden dieser API benötigen Sie kein Defender für IoT-Zugriffstoken.

URI: /api/external/authentication/validation

POST

Anforderung

Anforderungstyp: JSON

Abfrageparameter

Name	Typ	Erforderlich/optional
username	String	Erforderlich
password	String	Erforderlich

Anforderungsbeispiel:

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

Antwort

Typ: JSON

Meldungszeichenfolge mit Details zum Vorgangsstatus:

`Message`	BESCHREIBUNG
Erfolg: msg	Authentifizierung erfolgreich
Fehler: error	Fehler beim Überprüfen der Anmeldeinformationen

Antwortbeispiel

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

cURL-Befehl

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

Beispiel:

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

Nächste Schritte

Weitere Informationen finden Sie in der Übersicht zur API-Referenz – Defender for IoT.