Referensi API Microsoft Entra ID Windows Account Manager (WAM)
Microsoft Entra ID Windows Account Manager (WAM) adalah sekumpulan API yang memungkinkan pengembang mengintegrasikan aplikasi Windows. Parameter berikut dapat digunakan dengan MSAL pada platform Windows, memfasilitasi pengembangan aplikasi yang memungkinkan pengguna untuk masuk melalui ID Microsoft Entra atau akun Microsoft (MSA).
Referensi MICROSOFT Entra ID WAM API
| Parameter | Nilai | Catatan |
|---|---|---|
authority |
Baik organizations atau URL penerbit token tertentu. Misalnya, https://login.partner.microsoftonline.cn adalah URL penerbit token untuk lingkungan cloud. |
Parameter authority menentukan penyedia identitas dan lingkungan cloud untuk API Anda. |
resource |
URL tempat pengembang memperoleh token, seperti https://www.sharepoint.com |
Parameter resource menentukan URL target tempat token autentikasi diperoleh. |
redirect_uri |
Lokasi tempat server otorisasi mengirim pengguna setelah aplikasi berhasil diotorisasi dan memberikan kode otorisasi atau token akses. | Catatan: Parameter ini tidak didukung untuk aplikasi Platform Windows Universal (UWP). Pemanggil harus memiliki izin Tingkat Integritas Sedang. Lihat Pembatasan dan batasan URI Pengalihan (URL balasan) |
correlationId |
GUID unik yang dihasilkan untuk setiap permintaan yang dapat digunakan untuk menggabungkan permintaan di seluruh sumber data | Catatan: correlationId adalah parameter warisan. Ini telah diganti dengan properti di WAM API itu sendiri. Lihat Properti WebTokenRequest.CorrelationId (Windows.Security.Authentication.Web.Core) - Aplikasi Windows UWP |
validateAuthority |
Boolean; baik TRUE atau FALSE. |
Plugin ID Microsoft Entra melakukan validasi otoritas secara default. Jika aplikasi perlu menonaktifkan validasi ini, aplikasi harus mengirim nilai FALSE untuk validateAuthority. Ini dapat berguna dalam skenario lokal. Lihat Properti MsalAuthenticationOptions.ValidateAuthority |
certificateUsage |
vpn |
Parameter ini digunakan untuk meminta jenis token sertifikat. Satu-satunya nilai yang diizinkan adalah vpn. Saat ini, ini hanya berlaku untuk skenario VPN. |
certificateUIName |
String apa pun yang ditampilkan di UI pemilihan sertifikat untuk sertifikat VPN. | Parameter certificateUIName menentukan string yang ditampilkan dalam antarmuka pengguna pemilihan sertifikat saat memilih sertifikat VPN. |
certificateUIDescription |
String apa pun yang ditampilkan di UI pemilihan sertifikat untuk sertifikat VPN. | Parameter certificateUIDescription menentukan string yang ditampilkan dalam antarmuka pengguna pemilihan sertifikat sebagai deskripsi saat memilih sertifikat VPN. |
UserPictureEnabled |
Salah satu True atau False. |
Menunjukkan apakah aplikasi ingin menerima gambar pengguna sebagai bagian dari respons token. |
Username |
Nama pengguna | Mewakili nama pengguna ID Microsoft Entra |
Password |
Kata sandi | Mewakili Kata Sandi untuk pengguna ID Microsoft Entra |
SamlAssertion |
Token SAML | Token SAML dikirim sebagai artefak autentikasi dari IDP pihak ketiga ke ID Microsoft Entra |
SamlAssertionType |
Baik "urn:ietf:params:oauth:grant-type:saml1_1-bearer" atau "urn:ietf:params:oauth:grant-type:saml2-bearer" |
Menentukan jenis token SAML yang digunakan untuk autentikasi. |
LoginHint |
Petunjuk nama pengguna (upn) | Memberikan petunjuk untuk nama pengguna selama proses masuk. |
msafed |
Salah satu 0 atau 1. |
Menentukan apakah akan mengizinkan pengguna dengan akun Microsoft masuk sebagai identitas gabungan dalam penyewa Entra. Nilai 1 mengaktifkan federasi, sambil 0 menonaktifkannya. |
discover |
Home |
Parameter discover menunjukkan bahwa permintaan token dijalankan dalam konteks cloud rumah pengguna, bukan cloud tempat perangkat digabungkan. |
domain_hint |
Domain yang relevan. Misalnya: contoso.com |
MICROSOFT Entra ID menggunakan petunjuk untuk menemukan domain di direktori Catatan: petunjuk domain sedang diberikan prioritas atas domain fallback jika keduanya diteruskan sebagai parameter oleh ADAL |
fallback_domain |
Domain, seperti contoso.com |
Parameter fallback_domain adalah petunjuk yang digunakan MICROSOFT Entra ID untuk menemukan domain di direktori. Ini terutama digunakan untuk domain pengguna yang tidak dapat dialihkan yang merupakan bagian dari UPN pengguna. |
client_TokenType |
DeviceAuth |
Parameter client_TokenType digunakan secara eksklusif untuk meminta token khusus perangkat. Pemanggil harus memiliki izin tingkat integritas Sedang. |
IsFeatureSupported |
CrossCloudB2B, redirect_uri, TokenBinding. |
Digunakan untuk memeriksa apakah fitur didukung dalam alur saat ini. |
prompt |
Baik no_select atau select_account |
Parameter prompt mengontrol perilaku jendela prompt. no_select berarti tidak ada kontrol perilaku prompt yang ditambahkan ke jendela prompt. select_account menampilkan pemilih akun. Parameter diteruskan ke layanan masuk untuk mengontrol perilaku pemilihan akun. |
minimum_token_lifetime |
Waktu dalam milidetik. | Ini adalah waktu sebelum token baru perlu diminta dan token cache perlu dibuang |
telemetry |
MATS |
Mengembalikan telemetri tentang permintaan |
enclave |
sw menunjukkan kunci perangkat lunak, hw menunjukkan kunci perangkat keras, kg menunjukkan kunci keyguard. |
Parameter enclave menentukan jenis kunci yang akan digunakan. |
token_type |
pop menunjukkan bukti token kepemilikan shr menunjukkan token permintaan HTTP yang ditandatangani |
Parameter token_type menentukan jenis token yang akan digunakan. |
req_cnf |
Parameter req_cnf digunakan ketika token_type adalah pop. Bidang ini berisi informasi tentang kunci yang ingin diikat klien ke token akses untuk bukti kepemilikan. |
|
refresh_binding |
Parameter refresh_binding adalah bagian dari fitur pengikatan token yang akan datang yang belum dirilis. |