Dokumentacja interfejsu API zarządzania uwierzytelnianiem i hasłami dla lokalnych konsol zarządzania

W tym artykule wymieniono interfejsy API REST uwierzytelniania i zarządzania hasłami obsługiwane przez Microsoft Defender dla lokalnych konsol zarządzania IoT.

set_password (zmień hasło)

Użyj tego interfejsu API, aby umożliwić użytkownikom zmianę własnych haseł. Wszystkie role użytkowników usługi Defender dla IoT mogą współdziałać 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

POST

Żądanie

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

Odpowiedź

Typ: JSON

Komunikat	Opis
Powodzenie — 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 odpowiedzi

response:

{

    "error": {

        "userDisplayErrorMessage": "User authentication failure"

    }

}

polecenie cURL

Typ: POST

Interfejs API:

curl -k -d '{"username": "<USER_NAME>","password": "<CURRENT_PASSWORD>","new_password": "<NEW_PASSWORD>"}' -H 'Content-Type: application/json'  https://<IP_ADDRESS>/external/authentication/set_password

Przykład:

curl -k -d '{"username": "myUser","password": "1234@abcd","new_password": "abcd@1234"}' -H 'Content-Type: application/json'  https://127.0.0.1/external/authentication/set_password

set_password_by_admin (aktualizacja hasła użytkownika przez administratora systemu)

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ą współdziałać 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

Żądanie

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

Odpowiedź

Typ: JSON

Ciąg komunikatu ze szczegółami stanu operacji:

Komunikat	Opis
Powodzenie — 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 'yoavfe' doesn't exist"
    }

}

Pola urządzenia

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

polecenie cURL

Typ: POST

Interfejs API:

curl -k -d '{"admin_username":"<ADMIN_USERNAME>","admin_password":"<ADMIN_PASSWORD>","username": "<USER_NAME>","new_password": "<NEW_PASSWORD>"}' -H 'Content-Type: application/json'  https://<IP_ADDRESS>/external/authentication/set_password_by_admin

Przykład:

curl -k -d '{"admin_user":"adminUser","admin_password": "1234@abcd","username": "myUser","new_password": "abcd@1234"}' -H 'Content-Type: application/json'  https://127.0.0.1/external/authentication/set_password_by_admin

weryfikacja (Uwierzytelnianie poświadczeń użytkownika)

Użyj tego interfejsu API, aby zweryfikować poświadczenia użytkownika.

Do korzystania z tego interfejsu API nie jest potrzebny token dostępu usługi Defender dla IoT.

Identyfikator URI: /external/authentication/validation

POST

Żądanie

Typ: 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\!"

}

Odpowiedź

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."

}

cURL, polecenie

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>/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/external/authentication/validation

Następne kroki

Aby uzyskać więcej informacji, zobacz Omówienie interfejsu API usługi Defender for IoT.