CommonDeviceCodeRequest type

Paket:
@azure/msal-common

Parameter untuk alur kode perangkat Oauth2.

  • cakupan - Array cakupan yang diminta aplikasi aksesnya.
  • otoritas: - URL otoritas, layanan token keamanan (STS) tempat MSAL akan memperoleh token. Jika otoritas diatur pada objek aplikasi klien, ini akan mengambil alih nilai tersebut. Mengesampingkan nilai akan menyebabkan validasi otoritas terjadi setiap kali. Jika otoritas yang sama akan digunakan untuk semua permintaan, atur pada objek aplikasi alih-alih permintaan.
  • correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri.
  • deviceCodeCallback - Panggilan balik yang berisi respons kode perangkat. Pesan harus ditampilkan kepada pengguna akhir. Pengguna akhir kemudian dapat menavigasi ke verification_uri, memasukkan kredensial user_code, dan input.
  • cancel - Boolean untuk membatalkan polling titik akhir kode perangkat. Saat pengguna mengautentikasi pada perangkat terpisah, MSAL melakukan polling titik akhir token layanan token keamanan untuk interval yang ditentukan dalam respons kode perangkat (biasanya 15 menit). Untuk menghentikan polling dan membatalkan permintaan, atur cancel=true.
  • resourceRequestMethod - Jenis Permintaan HTTP yang digunakan untuk meminta data dari sumber daya (yaitu "GET", "POST", dll.). Digunakan untuk alur bukti kepemilikan.
  • resourceRequestUri - URI yang akan digunakan token. Digunakan untuk alur bukti kepemilikan.
  • timeout - Periode waktu habis dalam detik yang secara eksplisit dikonfigurasi pengguna untuk polling titik akhir kode perangkat. Pada akhir periode ini; dengan asumsi kode perangkat belum kedaluwarsa; polling kode perangkat dihentikan dan permintaan dibatalkan. Jendela kedaluwarsa kode perangkat akan selalu diutamakan selama periode yang ditetapkan ini.
  • extraQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke string kueri
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}