API-referens för autentisering och lösenordshantering för lokala hanteringskonsoler

Den här artikeln innehåller rest-API:er för autentisering och lösenordshantering som stöds för Microsoft Defender för lokala IoT-hanteringskonsoler.

set_password (Ändra lösenord)

Använd det här API:et för att låta användarna ändra sina egna lösenord. Alla Defender för IoT-användarroller kan fungera med API:et.

Du behöver ingen Defender for IoT-åtkomsttoken för att använda det här API:et.

URI: /external/authentication/set_password

POST

Förfrågan

Typ: JSON

Exempel:

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

Begärandeparametrar

Namn	Typ	Obligatoriskt/valfritt
Användarnamn	Sträng	Obligatorisk
lösenord	Sträng	Obligatorisk
new_password	Sträng	Obligatorisk

Response

Typ: JSON

Meddelande	Beskrivning
Lyckades – msg	Lösenordet har ersatts
Fel – fel	Fel vid användarautentisering
Fel – fel	Lösenordet matchar inte säkerhetsprincipen

Exempel på svar

response:

{

    "error": {

        "userDisplayErrorMessage": "User authentication failure"

    }

}

cURL-kommando

Typ: POST

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

Exempel:

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 (Uppdatering av användarlösenord av systemadministratör)

Använd det här API:et för att låta systemadministratörer ändra lösenord för angivna användare. Användarroller för Defender för IoT-administratör kan fungera med API:et.

Du behöver ingen Defender for IoT-åtkomsttoken för att använda det här API:et.

URI: /external/authentication/set_password_by_admin

POST

Förfrågan

Typ: JSON

Exempel på begäran

request:

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

Begärandeparametrar

Namn	Typ	Obligatoriskt/valfritt
admin_username	Sträng	Obligatorisk
admin_password	Sträng	Obligatorisk
Användarnamn	Sträng	Obligatorisk
new_password	Sträng	Obligatorisk

Response

Typ: JSON

Meddelandesträng med information om åtgärdsstatus:

Meddelande	Beskrivning
Lyckades – msg	Lösenordet har ersatts
Fel – fel	Fel vid användarautentisering
Fel – fel	Användaren finns inte
Fel – fel	Lösenordet matchar inte säkerhetsprincipen
Fel – fel	Användaren har inte behörighet att ändra lösenord

Exempel på svar

response:

{

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

}

Enhetsfält

Namn	Typ	Obligatoriskt/valfritt
admin_username	Sträng	Obligatorisk
admin_password	Sträng	Obligatorisk
Användarnamn	Sträng	Obligatorisk
new_password	Sträng	Obligatorisk

cURL-kommando

Typ: POST

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

Exempel:

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

validering (autentisera användarautentiseringsuppgifter)

Använd det här API:et för att verifiera användarautentiseringsuppgifter.

Du behöver ingen Defender for IoT-åtkomsttoken för att använda det här API:et.

URI: /external/authentication/validation

POST

Förfrågan

Typ: JSON

Frågeparametrar

Namn	Typ	Obligatorisk/valfri
Användarnamn	Sträng	Obligatorisk
lösenord	Sträng	Obligatorisk

Exempel på begäran

request:

{

    "username": "test",
    "password": "Test12345\!"

}

Response

Typ: JSON

Meddelandesträng med information om åtgärdsstatus:

Meddelande	Beskrivning
Lyckades – msg	Autentiseringen lyckades
Fel – fel	Verifieringen av autentiseringsuppgifter misslyckades

Exempel på svar

response:

{

    "msg": "Authentication succeeded."

}

cURL-kommando

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

Exempel:

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

Nästa steg

Mer information finns i referensöversikten för Defender för IoT API.