Hitelesítési és jelszókezelési API-referencia ot monitorozási érzékelőkhöz

Ez a cikk a Defender for IoT OT-érzékelőkhöz támogatott hitelesítési és jelszókezelési API-kat sorolja fel.

set_password (Jelszó módosítása)

Ezzel az API-val a felhasználók módosíthatják saját jelszavukat.

Az API használatához nincs szükség Az IoT-hez készült Defender hozzáférési jogkivonatára.

URI: /external/authentication/set_password

POST

Kérés

Típus: JSON

Példa:

request:

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

Kérelemparaméterek

Név	Típus	Kötelező/ Nem kötelező
Felhasználónév	Sztring	Kötelező
alaphelyzetbe állítása	Sztring	Kötelező
new_password	Sztring	Kötelező

Válasz

Típus: JSON

Üzenetsztring a művelet állapotadataival:

Üzenet	Leírás
Siker – msg	A jelszó lecserélve
Hiba – hiba	Felhasználói hitelesítési hiba
Hiba – hiba	A jelszó nem egyezik a biztonsági szabályzattal

Példa:

response:

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

cURL-parancs

Típus: 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

Példa:

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 (Felhasználói jelszó frissítése rendszergazda szerint)

Ezzel az API-val a rendszergazdák módosíthatják a megadott felhasználók jelszavát. Az IoT-hez készült Defender rendszergazdai felhasználói szerepkörei együttműködhetnek az API-val.

Az API használatához nincs szükség Az IoT-hez készült Defender hozzáférési jogkivonatára.

URI: /external/authentication/set_password_by_admin

POST

Kérés

Típus: JSON

Példa kérésre

request:

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

Kérelemparaméterek

Név	Típus	Kötelező/ Nem kötelező
admin_username	Sztring	Kötelező
admin_password	Sztring	Kötelező
Felhasználónév	Sztring	Kötelező
new_password	Sztring	Kötelező

Válasz

Típus: JSON

Üzenetsztring a művelet állapotadataival:

Üzenet	Leírás
Siker – msg	A jelszó lecserélve
Hiba – hiba	Felhasználói hitelesítési hiba
Hiba – hiba	A felhasználó nem létezik
Hiba – hiba	A jelszó nem egyezik a biztonsági szabályzattal
Hiba – hiba	A felhasználó nem rendelkezik a jelszó módosításához szükséges engedélyekkel

Példa válaszra

response:

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

cURL-parancs

Típus: 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

Példa:

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

érvényesítés (Felhasználói hitelesítő adatok ellenőrzése)

Ezzel az API-val érvényesítheti a Defender for IoT-felhasználónevet és -jelszót.

Az API használatához nincs szükség Az IoT-hez készült Defender hozzáférési jogkivonatára.

URI: /api/external/authentication/validation

POST

Kérés

Kérelem típusa: JSON

Lekérdezési paraméterek

Név	Típus	Kötelező vagy nem kötelező
Felhasználónév	Sztring	Kötelező
alaphelyzetbe állítása	Sztring	Kötelező

Példa kérésre:

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

Válasz

Típus: JSON

Üzenetsztring a művelet állapotadataival:

Üzenet	Leírás
Siker – msg	A hitelesítés sikeres volt
Hiba – hiba	A hitelesítő adatok érvényesítése nem sikerült

Példa válaszra

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

cURL-parancs

Típus: 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

Példa:

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

Következő lépések

További információ: A Defender for IoT API referencia áttekintése.