Bagikan melalui

Referensi API Sisi Server Akun Microsoft (MSA)

  • Artikel

Akun Microsoft (MSA) adalah layanan web akses menyeluruh yang memungkinkan pengguna untuk masuk ke situs web, aplikasi, dan layanan menggunakan satu set kredensial. API Sisi Server Akun Microsoft (MSA) menyediakan berbagai parameter yang dapat digunakan untuk menyesuaikan proses autentikasi dan meningkatkan pengalaman pengguna.

Parameter ini dapat digunakan dengan MSAL pada platform Windows, memfasilitasi pengembangan aplikasi Windows yang terintegrasi dengan mulus dengan pengguna yang masuk melalui akun Microsoft.

API Sisi Server MSA

Ini diteruskan ke login.microsoftonline.com atau login.live.com sebagai parameter URL, dalam format login.microsoftonline.com?parametername=value.

Parameter Nilai Catatan
ImplicitAssociate 0/1 Jika diatur ke 1, Akun Microsoft (MSA) yang digunakan pengguna untuk masuk secara otomatis ditautkan ke aplikasi di Windows, tanpa memerlukan konfirmasi pengguna.
Catatan: Ini tidak mengaktifkan akses menyeluruh (SSO) untuk pengguna.
LoginHint Nama pengguna Mengisi nama pengguna sebelumnya selama masuk, kecuali sudah disediakan (misalnya, melalui token refresh). Pengguna dapat mengubah nama pengguna yang telah diisi sebelumnya ini jika diperlukan.
cobrandid GUID kobranding Parameter ini menerapkan cobranding ke pengalaman pengguna masuk. Cobranding memungkinkan penyesuaian elemen seperti logo aplikasi, gambar latar belakang, teks subtitel, teks deskripsi, dan warna tombol. Jika Anda mengintegrasikan aplikasi dengan rincian masuk akun Microsoft dan ingin menyesuaikan layar masuk, hubungi dukungan Microsoft.
client_flight String client_flight adalah parameter passthrough yang dikembalikan ke aplikasi setelah proses masuk selesai. Nilai parameter ini dicatat ke aliran telemetri dan digunakan oleh aplikasi untuk mengikat permintaan autentikasi mereka. Ini dapat bermanfaat untuk menghubungkan permintaan masuk, bahkan jika tidak semua aplikasi memiliki akses ke aliran telemetri ini. Aplikasi seperti Office Union, Teams, dan lainnya adalah pengguna penting dari parameter ini.
lw 0/1 Catatan: Fitur ini tidak digunakan lagi. Mengaktifkan Pendaftaran Ringan. Jika diaktifkan, pengguna yang mendaftar melalui alur autentikasi tidak diharuskan memasukkan nama depan, nama belakang, negara, dan tanggal lahir mereka, kecuali diamanatkan oleh undang-undang yang berlaku untuk wilayah pengguna.
fl phone2,
email,
wld,
wld2,
easi,
easi2		 Catatan: Fitur ini tidak digunakan lagi. Parameter ini mengontrol opsi nama pengguna yang disediakan selama proses pendaftaran:
phone – Membatasi nama pengguna ke nomor telepon,
phone2 – Default ke nomor telepon, tetapi memungkinkan opsi lain,
email – Membatasi nama pengguna ke email (Outlook atau EASI),
wld – Membatasi nama pengguna ke Outlook,
wld2 – Default ke Outlook, tetapi memungkinkan opsi lain, termasuk telepon,
easi – Membatasi nama pengguna ke EASI,
easi2 – Default ke EASI, tetapi memungkinkan opsi lain, termasuk telepon.
nopa 0/1/2 Catatan: Fitur ini tidak digunakan lagi. Mengaktifkan pendaftaran tanpa kata sandi. Nilai 1 memungkinkan pendaftaran tanpa kata sandi, tetapi memberlakukan pembuatan kata sandi setelah 30 hari. Nilai 2 memungkinkan pendaftaran tanpa kata sandi tanpa batas waktu. Untuk menggunakan nilai 2, aplikasi harus ditambahkan ke daftar yang diizinkan melalui proses manual.
coa 0/1 Catatan: Fitur ini tidak digunakan lagi. Mengaktifkan masuk tanpa kata sandi dengan mengirim kode ke nomor telepon pengguna. Untuk menggunakan nilai 1, aplikasi harus ditambahkan ke daftar yang diizinkan melalui proses manual.
signup 0/1 Mulai alur autentikasi di halaman Buat akun daripada halaman Masuk .
fluent 0/1 Catatan: Fitur ini tidak digunakan lagi. Memungkinkan tampilan dan nuansa Fasih baru untuk alur masuk. Untuk menggunakan nilai 1, aplikasi harus ditambahkan ke daftar yang diizinkan melalui proses manual.
api-version “”/”2.0” Ketika diatur ke 2.0, parameter ini memungkinkan clientid untuk menentukan ID Aplikasi yang berbeda dari yang terdaftar oleh aplikasi panggilan Windows, mengingat bahwa ID Aplikasi yang ditentukan dikonfigurasi untuk mengizinkan ini.
Clientid/client_id app ID ID aplikasi untuk aplikasi yang memanggil alur autentikasi.
Client_uiflow new_account Memungkinkan aplikasi menambahkan akun baru tanpa memanggil Akun Pengaturan Pane. Mengharuskan Anda juga meneruskan jenis perintah ForceAuthentication. Mengharuskan Anda juga meneruskan jenis perintah ForceAuthentication .

Parameter Token Otorisasi MSA

Parameter Nilai Catatan
scope String Menentukan sejauh mana izin yang diminta oleh klien di titik akhir otorisasi dan token.
claims String Menentukan klaim opsional yang diminta oleh aplikasi klien.
response_type String Menentukan nilai Jenis Respons OAuth 2.0 yang menentukan alur proses otorisasi, termasuk parameter yang dikembalikan dari titik akhir masing-masing.
phone String Menentukan daftar nomor telepon yang diformat yang dipisahkan koma yang ditautkan ke perangkat host.
qrcode_uri String Dalam permintaan pembuatan kode QR untuk mentransfer sesi terautentikasi, URL ini disematkan ke dalam kode QR.
Ttv 1 / 2 TBD
qrcode_state String Dalam permintaan pembuatan kode QR, parameter status ini dimasukkan ke dalam URL yang ditampilkan dalam kode QR.
Child_client_id String ID aplikasi klien anak dalam alur broker ganda.
child_redirect_uri String URI pengalihan aplikasi klien anak yang digunakan dalam alur broker ganda.
safe_rollout String Parameter yang digunakan untuk menentukan rencana peluncuran aman yang diterapkan pada permintaan. Berguna saat pemilik aplikasi meluncurkan perubahan konfigurasi aplikasi dan ingin perubahan diterapkan secara bertahap untuk tujuan penyebaran keamanan.
additional_scope String Menentukan cakupan tambahan sehingga layanan autentikasi dapat mengumpulkan persetujuan tambahan dalam satu permintaan. Dengan cara ini, aplikasi klien dapat menghindari gangguan persetujuan saat meminta cakupan yang berbeda di masa mendatang.
x-client-info 1/0 Token Client_info dikembalikan saat nilainya adalah 1,0.
challenge String Awalnya disediakan oleh aplikasi sumber daya, aplikasi ini diteruskan oleh aplikasi klien ke server MSA tanpa modifikasi apa pun.
max_age Bilangan bulat Usia Autentikasi Maksimum. Menentukan waktu berlalu yang diizinkan dalam detik sejak terakhir kali Pengguna Akhir secara aktif diautentikasi oleh MSA.
mfa_max_age Bilangan bulat Menentukan waktu berlalu yang diperbolehkan dalam hitungan detik sejak terakhir kali pengguna melewati autentikasi multifaktor pada MSA.
acr_values String Nilai Referensi Kelas Konteks Autentikasi yang Diminta. String yang dipisahkan spasi yang menentukan nilai acr yang diminta server otorisasi untuk digunakan untuk memproses Permintaan Autentikasi ini, dengan nilai muncul dalam urutan preferensi. Kelas Konteks Autentikasi yang dipenuhi oleh autentikasi yang dilakukan dikembalikan sebagai Nilai Klaim acr.
redirect_uri String URI pengalihan tempat respons dikirim. URI ini harus sama persis dengan salah satu nilai URI Pengalihan untuk Klien yang telah terdaftar di MSA.
state String Nilai buram yang digunakan untuk mempertahankan status antara permintaan dan panggilan balik.
oauth2_response 1 Jika sama dengan 1, itu berarti respons ws-trust harus mengikuti format respons OAuth.

Lihat juga