Informazioni di riferimento sulle API di autenticazione e gestione delle password per i sensori di monitoraggio OT

Questo articolo elenca le API di gestione delle password e di autenticazione supportate per i sensori OT di Defender per IoT.

set_password (Modificare la password)

Usare questa API per consentire agli utenti di modificare le proprie password.

Per usare questa API non è necessario un token di accesso di Defender per IoT.

URI: /external/authentication/set_password

POST

Richiesta

Tipo: JSON

Esempio:

request:

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

Parametri della richiesta

Nome	Tipo	Obbligatoria / Facoltativa
username	string	Necessario
password	string	Necessario
new_password	string	Necessario

Risposta

Tipo: JSON

Stringa di messaggio con i dettagli dello stato dell'operazione:

Message	Descrizione
Success – msg	La password è stata sostituita
Errore : errore	Errore di autenticazione utente
Errore : errore	La password non corrisponde ai criteri di sicurezza

Esempio:

response:

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

Comando cURL

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

Esempio:

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 (aggiornare una password utente in base all'amministratore)

Usare questa API per consentire agli amministratori di sistema di modificare le password per gli utenti specificati. I ruoli utente dell'amministratore di Defender per IoT possono usare l'API.

Per usare questa API non è necessario un token di accesso di Defender per IoT.

URI: /external/authentication/set_password_by_admin

POST

Richiesta

Tipo: JSON

Esempio di richiesta

request:

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

Parametri della richiesta

Nome	Tipo	Obbligatoria / Facoltativa
admin_username	string	Necessario
admin_password	string	Necessario
username	string	Necessario
new_password	string	Necessario

Risposta

Tipo: JSON

Stringa di messaggio con i dettagli dello stato dell'operazione:

Message	Descrizione
Success – msg	La password è stata sostituita
Errore : errore	Errore di autenticazione utente
Errore : errore	L'utente non esiste
Errore : errore	La password non corrisponde ai criteri di sicurezza
Errore : errore	L'utente non dispone delle autorizzazioni per modificare la password

Esempio di risposta

response:

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

Comando cURL

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

Esempio:

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

convalida (convalidare le credenziali utente)

Usare questa API per convalidare un nome utente e una password di Defender per IoT.

Per usare questa API non è necessario un token di accesso di Defender per IoT.

URI: /api/external/authentication/validation

POST

Richiesta

Tipo di richiesta: JSON

Parametri di query

Nome	Tipo	Obbligatorio/facoltativo
username	string	Necessario
password	string	Necessario

Esempio di richiesta:

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

Risposta

Tipo: JSON

Stringa di messaggio con i dettagli dello stato dell'operazione:

Message	Descrizione
Operazione riuscita - msg	Autenticazione completata
Errore - errore	Convalida delle credenziali non riuscita

Esempio di risposta

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

Comando cURL

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

Esempio:

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

Passaggi successivi

Per altre informazioni, vedere la panoramica di riferimento sull'API Defender per IoT.