Verificatie- en wachtwoordbeheer-API-naslaginformatie voor OT-bewakingssensoren

In dit artikel worden de verificatie- en wachtwoordbeheer-API's vermeld die worden ondersteund voor Defender for IoT OT-sensoren.

set_password (Uw wachtwoord wijzigen)

Gebruik deze API om gebruikers hun eigen wachtwoorden te laten wijzigen.

U hebt geen Defender for IoT-toegangstoken nodig om deze API te gebruiken.

URI: /external/authentication/set_password

POST

Aanvraag

Type: JSON

Voorbeeld:

request:

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

Aanvraagparameters

Naam	Type	Vereist/optioneel
Gebruikersnaam	Tekenreeks	Vereist
password	Tekenreeks	Vereist
new_password	Tekenreeks	Vereist

Response

Type: JSON

Berichttekenreeks met de details van de bewerkingsstatus:

Bericht	Beschrijving
Geslaagd – msg	Wachtwoord is vervangen
Fout : fout	Fout bij gebruikersverificatie
Fout : fout	Wachtwoord komt niet overeen met beveiligingsbeleid

Voorbeeld:

response:

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

cURL-opdracht

Type: 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

Voorbeeld:

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 (Een gebruikerswachtwoord bijwerken door de beheerder)

Gebruik deze API om systeembeheerders wachtwoorden voor opgegeven gebruikers te laten wijzigen. Defender for IoT-beheerdersgebruikersrollen kunnen werken met de API.

U hebt geen Defender for IoT-toegangstoken nodig om deze API te gebruiken.

URI: /external/authentication/set_password_by_admin

POST

Aanvraag

Type: JSON

Voorbeeld van aanvraag

request:

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

Aanvraagparameters

Naam	Type	Vereist/optioneel
admin_username	Tekenreeks	Vereist
admin_password	Tekenreeks	Vereist
Gebruikersnaam	Tekenreeks	Vereist
new_password	Tekenreeks	Vereist

Response

Type: JSON

Berichttekenreeks met de details van de bewerkingsstatus:

Bericht	Beschrijving
Geslaagd – msg	Wachtwoord is vervangen
Fout : fout	Fout bij gebruikersverificatie
Fout : fout	Gebruiker bestaat niet
Fout : fout	Wachtwoord komt niet overeen met beveiligingsbeleid
Fout : fout	Gebruiker heeft niet de machtigingen om het wachtwoord te wijzigen

Voorbeeld van antwoord

response:

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

cURL-opdracht

Type: 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

Voorbeeld:

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

validatie (gebruikersreferenties valideren)

Gebruik deze API om de gebruikersnaam en het wachtwoord van Defender for IoT te valideren.

U hebt geen Defender for IoT-toegangstoken nodig om deze API te gebruiken.

URI: /api/external/authentication/validation

POST

Aanvraag

Aanvraagtype: JSON

Queryparameters

Naam	Type	Vereist/optioneel
Gebruikersnaam	Tekenreeks	Vereist
password	Tekenreeks	Vereist

Voorbeeld van aanvraag:

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

Response

Type: JSON

Berichtreeks met de details van de bewerkingsstatus:

Bericht	Beschrijving
Geslaagd - msg	De verificatie is voltooid
Fout - fout	Validatie van referenties is mislukt

Voorbeeld van antwoord

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

cURL-opdracht

Type: 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

Voorbeeld:

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

Volgende stappen

Zie het overzicht naslaginformatie over Defender for IoT API voor meer informatie.