OT izleme algılayıcıları için kimlik doğrulama ve parola yönetimi API başvurusu

Bu makalede, IoT için Defender OT algılayıcıları için desteklenen kimlik doğrulama ve parola yönetimi API'leri listelenir.

set_password (Parolanızı değiştirin)

Kullanıcıların kendi parolalarını değiştirmesine izin vermek için bu API'yi kullanın.

Bu API'yi kullanmak için IoT için Defender erişim belirtecine ihtiyacınız yoktur.

URI: /external/authentication/set_password

POST

İstek

Tür: JSON

Örnek:

request:

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

İstek parametreleri

Ad	Tür	Gerekli / İsteğe Bağlı
Username	Dize	Gerekli
parola	Dize	Gerekli
new_password	Dize	Gerekli

Response

Tür: JSON

İşlem durumu ayrıntılarını içeren ileti dizesi:

İleti	Açıklama
Success – msg	Parola değiştirildi
Hata – hata	Kullanıcı kimlik doğrulaması hatası
Hata – hata	Parola güvenlik ilkesiyle eşleşmiyor

Örnek:

response:

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

cURL komutu

Tür: 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

Örnek:

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 (Kullanıcı parolasını yönetici tarafından güncelleştirme)

Sistem yöneticilerinin belirtilen kullanıcıların parolalarını değiştirmesine izin vermek için bu API'yi kullanın. IoT için Defender yönetici kullanıcı rolleri API ile çalışabilir.

Bu API'yi kullanmak için IoT için Defender erişim belirtecine ihtiyacınız yoktur.

URI: /external/authentication/set_password_by_admin

POST

İstek

Tür: JSON

İstek örneği

request:

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

İstek parametreleri

Ad	Tür	Gerekli / İsteğe Bağlı
admin_username	Dize	Gerekli
admin_password	Dize	Gerekli
Username	Dize	Gerekli
new_password	Dize	Gerekli

Response

Tür: JSON

İşlem durumu ayrıntılarını içeren ileti dizesi:

İleti	Açıklama
Success – msg	Parola değiştirildi
Hata – hata	Kullanıcı kimlik doğrulaması hatası
Hata – hata	Kullanıcı yok
Hata – hata	Parola güvenlik ilkesiyle eşleşmiyor
Hata – hata	Kullanıcının parola değiştirme izinleri yok

Yanıt örneği

response:

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

cURL komutu

Tür: 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

Örnek:

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

doğrulama (Kullanıcı kimlik bilgilerini doğrulama)

IoT için Defender kullanıcı adını ve parolasını doğrulamak için bu API'yi kullanın.

Bu API'yi kullanmak için IoT için Defender erişim belirtecine ihtiyacınız yoktur.

URI: /api/external/authentication/validation

POST

İstek

İstek türü: JSON

Sorgu parametreleri

Ad	Tür	Gerekli/İsteğe Bağlı
Username	Dize	Gerekli
parola	Dize	Gerekli

İstek örneği:

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

Response

Tür: JSON

İşlem durumu ayrıntılarını içeren ileti dizesi:

İleti	Açıklama
Success - msg	Kimlik doğrulaması başarılı oldu
Hata - hata	Kimlik bilgileri doğrulaması başarısız oldu

Yanıt örneği

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

cURL komutu

Tür: 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

Örnek:

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

Sonraki adımlar

Daha fazla bilgi için bkz. IoT için Defender API başvurusuna genel bakış.