Referenční informace k rozhraní API pro ověřování a správu hesel pro senzory monitorování OT

Tento článek obsahuje seznam rozhraní API pro ověřování a správu hesel podporovaná pro senzory OT Defenderu for IoT.

set_password (změna hesla)

Pomocí tohoto rozhraní API můžete uživatelům umožnit změnu vlastních hesel.

K použití tohoto rozhraní API nepotřebujete přístupový token Defenderu for IoT.

Identifikátor URI: /external/authentication/set_password

POST

Žádost

Typ: JSON

Příklad:

request:

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

Parametry požadavku

Název	Typ	Povinné/volitelné
Username	Řetězec	Vyžadováno
heslo	Řetězec	Vyžadováno
new_password	Řetězec	Vyžadováno

Response

Typ: JSON

Řetězec zprávy s podrobnostmi o stavu operace:

Zpráva	Popis
Úspěch – msg	Heslo bylo nahrazeno.
Selhání – chyba	Selhání ověřování uživatelů
Selhání – chyba	Heslo neodpovídá zásadám zabezpečení

Příklad:

response:

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

Příkaz cURL

Typ: POST

Rozhraní 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říklad:

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 (aktualizace hesla uživatele správcem)

Pomocí tohoto rozhraní API můžete správcům systému umožnit měnit hesla pro zadané uživatele. Uživatelské role správce Defenderu for IoT můžou pracovat s rozhraním API.

K použití tohoto rozhraní API nepotřebujete přístupový token Defenderu for IoT.

Identifikátor URI: /external/authentication/set_password_by_admin

POST

Žádost

Typ: JSON

Příklad požadavku

request:

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

Parametry požadavku

Název	Typ	Povinné/volitelné
admin_username	Řetězec	Vyžadováno
admin_password	Řetězec	Vyžadováno
Username	Řetězec	Vyžadováno
new_password	Řetězec	Vyžadováno

Response

Typ: JSON

Řetězec zprávy s podrobnostmi o stavu operace:

Zpráva	Popis
Úspěch – msg	Heslo bylo nahrazeno.
Selhání – chyba	Selhání ověřování uživatelů
Selhání – chyba	Uživatel neexistuje.
Selhání – chyba	Heslo neodpovídá zásadám zabezpečení
Selhání – chyba	Uživatel nemá oprávnění ke změně hesla.

Příklad odpovědi

response:

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

Příkaz cURL

Typ: POST

Rozhraní 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říklad:

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

ověření (ověření přihlašovacích údajů uživatele)

Pomocí tohoto rozhraní API můžete ověřit uživatelské jméno a heslo Defenderu for IoT.

K použití tohoto rozhraní API nepotřebujete přístupový token Defenderu for IoT.

Identifikátor URI: /api/external/authentication/validation

POST

Žádost

Typ požadavku: JSON

Parametry dotazů

Název	Typ	Požadováno/volitelné
Username	Řetězec	Vyžadováno
heslo	Řetězec	Vyžadováno

Příklad požadavku:

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

Response

Typ: JSON

Řetězec zprávy s podrobnostmi o stavu operace:

Zpráva	Popis
Úspěch – msg	Ověření proběhlo úspěšně.
Selhání – chyba	Ověření přihlašovacích údajů se nezdařilo.

Příklad odpovědi

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

Příkaz cURL

Typ: POST

ROZHRANÍ 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říklad:

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

Další kroky

Další informace najdete v referenčním přehledu rozhraní Defender for IoT API.