Dokumentacja interfejsu API uwierzytelniania i zarządzania hasłami dla czujników monitorowania ot
Artykuł 06/01/2023
Współautorzy: 2
Opinia
W tym artykule
W tym artykule wymieniono interfejsy API uwierzytelniania i zarządzania hasłami obsługiwane dla czujników ot usługi Defender for IoT.
set_password (zmień hasło)
Użyj tego interfejsu API, aby umożliwić użytkownikom zmianę własnych haseł.
Do korzystania z tego interfejsu API nie jest potrzebny token dostępu usługi Defender dla IoT.
Identyfikator URI : /external/authentication/set_password
POST
Typ : JSON
Przykład:
request:
{
"username": "test",
"password": "Test12345\!",
"new_password": "Test54321\!"
}
Parametry żądania
Nazwa
Typ
Wymagane /Opcjonalne
Nazwę użytkownika
Ciąg
Wymagane
hasło
Ciąg
Wymagane
new_password
Ciąg
Wymagane
Typ : JSON
Ciąg komunikatu ze szczegółami stanu operacji:
Komunikat
Opis
Sukces — msg
Hasło zostało zastąpione
Błąd — błąd
Niepowodzenie uwierzytelniania użytkownika
Błąd — błąd
Hasło nie jest zgodne z zasadami zabezpieczeń
Przykład:
response:
{
"error": {
"userDisplayErrorMessage": "User authentication failure"
}
}
Typ : POST
Interfejs 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
Przykład:
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 (Aktualizowanie hasła użytkownika przez administratora)
Użyj tego interfejsu API, aby umożliwić administratorom systemu zmianę haseł dla określonych użytkowników. Role użytkowników administratora usługi Defender for IoT mogą pracować z interfejsem API.
Do korzystania z tego interfejsu API nie jest potrzebny token dostępu usługi Defender dla IoT.
Identyfikator URI : /external/authentication/set_password_by_admin
POST
Typ : JSON
Przykład żądania
request:
{
"admin_username": "admin",
"admin_password: "Test0987"
"username": "test",
"new_password": "Test54321\!"
}
Parametry żądania
Nazwa
Typ
Wymagane /Opcjonalne
admin_username
Ciąg
Wymagane
admin_password
Ciąg
Wymagane
Nazwę użytkownika
Ciąg
Wymagane
new_password
Ciąg
Wymagane
Typ : JSON
Ciąg komunikatu ze szczegółami stanu operacji:
Komunikat
Opis
Sukces — msg
Hasło zostało zastąpione
Błąd — błąd
Niepowodzenie uwierzytelniania użytkownika
Błąd — błąd
Użytkownik nie istnieje
Błąd — błąd
Hasło nie jest zgodne z zasadami zabezpieczeń
Błąd — błąd
Użytkownik nie ma uprawnień do zmiany hasła
Przykład odpowiedzi
response:
{
"error": {
"userDisplayErrorMessage": "The user 'test_user' doesn't exist",
"internalSystemErrorMessage": "The user 'test_user' doesn't exist"
}
}
Typ : POST
Interfejs 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
Przykład:
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
weryfikacja (weryfikowanie poświadczeń użytkownika)
Użyj tego interfejsu API, aby zweryfikować nazwę użytkownika i hasło usługi Defender for IoT.
Do korzystania z tego interfejsu API nie jest potrzebny token dostępu usługi Defender dla IoT.
Identyfikator URI : /api/external/authentication/validation
POST
Typ żądania : JSON
Parametry zapytania
Nazwa
Typ
Wymagane/Opcjonalne
Nazwę użytkownika
Ciąg
Wymagane
hasło
Ciąg
Wymagane
Przykład żądania:
request:
{
"username": "test",
"password": "Test12345\!"
}
Typ : JSON
Ciąg komunikatu ze szczegółami stanu operacji:
Komunikat
Opis
Powodzenie — msg
Uwierzytelnianie zakończyło się pomyślnie
Błąd — błąd
Sprawdzanie poprawności poświadczeń nie powiodło się
Przykład odpowiedzi
response:
{
"msg": "Authentication succeeded."
}
Typ : POST
Interfejs 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
Przykład:
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
Następne kroki
Aby uzyskać więcej informacji, zobacz Omówienie interfejsu API usługi Defender for IoT .