Referensi API autentikasi dan manajemen kata sandi untuk konsol manajemen lokal
Artikel 06/01/2023
2 kontributor
Saran dan Komentar
Dalam artikel ini
Artikel ini mencantumkan REST API autentikasi dan manajemen kata sandi yang didukung untuk Microsoft Defender untuk konsol manajemen lokal IoT.
set_password (Ubah kata sandi)
Gunakan API ini untuk memungkinkan pengguna mengubah kata sandi mereka sendiri. Semua peran pengguna Defender untuk IoT dapat bekerja dengan API.
Anda tidak memerlukan token akses Defender untuk IoT untuk menggunakan API ini.
URI : /external/authentication/set_password
POST
Jenis : JSON
Contoh :
request:
{
"username": "test",
"password": "Test12345\!",
"new_password": "Test54321\!"
}
Parameter permintaan
Nama Jenis Diperlukan/Opsional
username String
Diperlukan
password String
Diperlukan
kata sandi_baru String
Diperlukan
Jenis : JSON
Pesan
Deskripsi
Sukses – msg Kata sandi telah diganti
Kegagalan – kesalahan Kegagalan autentikasi pengguna
Kegagalan – kesalahan Kata sandi tidak cocok dengan kebijakan keamanan
Contoh respons
response:
{
"error": {
"userDisplayErrorMessage": "User authentication failure"
}
}
Jenis : 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
Contoh :
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 (Pembaruan kata sandi pengguna oleh admin sistem)
Gunakan API ini untuk memungkinkan administrator sistem mengubah kata sandi untuk pengguna tertentu. Pembela untuk peran pengguna admin IoT dapat bekerja dengan API.
Anda tidak memerlukan token akses Defender untuk IoT untuk menggunakan API ini.
URI : /external/authentication/set_password_by_admin
POST
Jenis : JSON
Contoh permintaan
request:
{
"admin_username": "admin",
"admin_password: "Test0987"
"username": "test",
"new_password": "Test54321\!"
}
Parameter permintaan
Nama Jenis Diperlukan/Opsional
namapengguna_admin String
Diperlukan
admin_kata sandi String
Diperlukan
username String
Diperlukan
kata sandi_baru String
Diperlukan
Jenis : JSON
String pesan dengan detail status operasi:
Pesan
Deskripsi
Sukses – msg Kata sandi telah diganti
Kegagalan – kesalahan Kegagalan autentikasi pengguna
Kegagalan – kesalahan Pengguna tidak ada
Kegagalan – kesalahan Kata sandi tidak cocok dengan kebijakan keamanan
Kegagalan – kesalahan Pengguna tidak memiliki izin untuk mengubah kata sandi
Contoh respons
response:
{
"error": {
"userDisplayErrorMessage": "The user 'test_user' doesn't exist",
"internalSystemErrorMessage": "The user 'yoavfe' doesn't exist"
}
}
Bidang perangkat
Nama Jenis Diperlukan/Opsional
namapengguna_admin String
Diperlukan
admin_kata sandi String
Diperlukan
username String
Diperlukan
kata sandi_baru String
Diperlukan
Jenis : 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
Contoh :
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
validasi (Autentikasi kredensial pengguna)
Gunakan API ini untuk memvalidasi kredensial pengguna.
Anda tidak memerlukan token akses Defender untuk IoT untuk menggunakan API ini.
URI : /external/authentication/validation
POST
Jenis : JSON
Parameter kueri
Nama Jenis Diperlukan/Opsional
username String
Diperlukan
password String
Diperlukan
Contoh permintaan
request:
{
"username": "test",
"password": "Test12345\!"
}
Jenis : JSON
String pesan dengan detail status operasi:
Pesan
Deskripsi
Sukses - msg Autentikasi berhasil
Kegagalan - kesalahan Validasi kredensial gagal
Contoh respons
response:
{
"msg": "Authentication succeeded."
}
Jenis : 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
Contoh :
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
Langkah berikutnya
Untuk informasi selengkapnya, lihat Ringkasan referensi Defender for IoT API .