InteractiveBrowserCredentialInBrowserOptions interface

Paket:

@azure/identity

Menentukan opsi umum untuk kelas InteractiveBrowserCredential.

Memperluas

InteractiveCredentialOptions

Properti

clientId	ID Klien aplikasi Microsoft Entra yang akan masuk pengguna. Parameter ini diperlukan di browser. Pengembang perlu mendaftarkan aplikasi mereka dan menetapkan peran yang sesuai. Untuk informasi selengkapnya, kunjungi https://aka.ms/identity/AppRegistrationAndRoleAssignment.
loginHint	loginHint memungkinkan nama pengguna untuk dipilih sebelumnya untuk masuk interaktif. Mengatur opsi ini melewati perintah pemilihan akun dan segera mencoba masuk dengan akun yang ditentukan.
loginStyle	Menentukan apakah pengalihan atau jendela popup harus digunakan untuk memulai alur autentikasi pengguna. Nilai yang mungkin adalah "pengalihan" atau "popup" (default) untuk browser dan "popup" (default) untuk simpul.
redirectUri	Mendapatkan URI pengalihan aplikasi. Ini harus sama dengan nilai di portal pendaftaran aplikasi. Default ke window.location.href. Bidang ini tidak lagi diperlukan untuk Node.js.
tenantId	ID penyewa (direktori) Microsoft Entra.

Properti yang Diwariskan

additionallyAllowedTenants	Untuk aplikasi multi-penyewa, menentukan penyewa tambahan yang kredensialnya dapat memperoleh token. Tambahkan nilai kartubebas "*" untuk memungkinkan kredensial memperoleh token untuk penyewa apa pun yang diinstal aplikasi.
additionalPolicies	Kebijakan tambahan untuk disertakan dalam alur HTTP.
agent	Opsi untuk mengonfigurasi instans Agen untuk permintaan keluar
allowInsecureConnection	Atur ke true jika permintaan dikirim melalui HTTP alih-alih HTTPS
authenticationRecord	Hasil autentikasi sebelumnya yang dapat digunakan untuk mengambil kredensial yang di-cache dari setiap akun individu. Hal ini diperlukan untuk diberikan jika aplikasi ingin bekerja dengan lebih dari satu akun per ID Klien dan pasangan ID Penyewa. Rekaman ini dapat diambil dengan memanggil metode authenticate() kredensial, sebagai berikut: const authenticationRecord = await credential.authenticate();
authorityHost	Host otoritas yang digunakan untuk permintaan autentikasi. Nilai yang mungkin tersedia melalui AzureAuthorityHosts. Defaultnya adalah "https://login.microsoftonline.com".
disableAutomaticAuthentication	Membuat getToken melempar jika autentikasi manual diperlukan. Pengembang perlu memanggil ke authenticate() untuk mengontrol kapan harus mengautentikasi secara manual.
disableInstanceDiscovery	Bidang menentukan apakah penemuan instans dilakukan saat mencoba mengautentikasi. Mengatur ini ke true akan sepenuhnya menonaktifkan penemuan instans dan validasi otoritas. Akibatnya, sangat penting untuk memastikan bahwa host otoritas yang dikonfigurasi valid dan dapat dipercaya. Fungsionalitas ini ditujukan untuk digunakan dalam skenario di mana titik akhir metadata tidak dapat dicapai, seperti di cloud privat atau Azure Stack. Proses penemuan instans memerlukan pengambilan metadata otoritas dari https://login.microsoft.com/ untuk memvalidasi otoritas.
httpClient	HttpClient yang akan digunakan untuk mengirim permintaan HTTP.
loggingOptions	Memungkinkan pengguna untuk mengonfigurasi pengaturan untuk opsi kebijakan pengelogan, memungkinkan informasi akun pengelogan dan informasi identitas pribadi untuk dukungan pelanggan.
proxyOptions	Opsi untuk mengonfigurasi proksi untuk permintaan keluar.
redirectOptions	Opsi untuk bagaimana respons pengalihan ditangani.
retryOptions	Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.
telemetryOptions	Opsi untuk mengatur telemetri umum dan melacak info ke permintaan keluar.
tlsOptions	Opsi untuk mengonfigurasi autentikasi TLS
userAgentOptions	Opsi untuk menambahkan detail agen pengguna ke permintaan keluar.

Detail Properti

clientId

ID Klien aplikasi Microsoft Entra yang akan masuk pengguna. Parameter ini diperlukan di browser. Pengembang perlu mendaftarkan aplikasi mereka dan menetapkan peran yang sesuai. Untuk informasi selengkapnya, kunjungi https://aka.ms/identity/AppRegistrationAndRoleAssignment.

clientId: string

Nilai Properti

string

loginHint

loginHint memungkinkan nama pengguna untuk dipilih sebelumnya untuk masuk interaktif. Mengatur opsi ini melewati perintah pemilihan akun dan segera mencoba masuk dengan akun yang ditentukan.

loginHint?: string

Nilai Properti

string

loginStyle

Menentukan apakah pengalihan atau jendela popup harus digunakan untuk memulai alur autentikasi pengguna. Nilai yang mungkin adalah "pengalihan" atau "popup" (default) untuk browser dan "popup" (default) untuk simpul.

loginStyle?: BrowserLoginStyle

Nilai Properti

BrowserLoginStyle

redirectUri

Mendapatkan URI pengalihan aplikasi. Ini harus sama dengan nilai di portal pendaftaran aplikasi. Default ke window.location.href. Bidang ini tidak lagi diperlukan untuk Node.js.

redirectUri?: string | () => string

Nilai Properti

string | () => string

tenantId

ID penyewa (direktori) Microsoft Entra.

tenantId?: string

Nilai Properti

string

Detail Properti yang Diwariskan

additionallyAllowedTenants

Untuk aplikasi multi-penyewa, menentukan penyewa tambahan yang kredensialnya dapat memperoleh token. Tambahkan nilai kartubebas "*" untuk memungkinkan kredensial memperoleh token untuk penyewa apa pun yang diinstal aplikasi.

additionallyAllowedTenants?: string[]

Nilai Properti

string[]

Diwarisi DariInteractiveCredentialOptions.additionallyAllowedTenants

additionalPolicies

Kebijakan tambahan untuk disertakan dalam alur HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Nilai Properti

AdditionalPolicyConfig[]

Diwariskan DariInteractiveCredentialOptions.additionalPolicies

agent

Opsi untuk mengonfigurasi instans Agen untuk permintaan keluar

agent?: Agent

Nilai Properti

Agent

Diwarisi dariInteractiveCredentialOptions.agent

allowInsecureConnection

Atur ke true jika permintaan dikirim melalui HTTP alih-alih HTTPS

allowInsecureConnection?: boolean

Nilai Properti

boolean

Diwarisi DariInteractiveCredentialOptions.allowInsecureConnection

authenticationRecord

Hasil autentikasi sebelumnya yang dapat digunakan untuk mengambil kredensial yang di-cache dari setiap akun individu. Hal ini diperlukan untuk diberikan jika aplikasi ingin bekerja dengan lebih dari satu akun per ID Klien dan pasangan ID Penyewa.

Rekaman ini dapat diambil dengan memanggil metode authenticate() kredensial, sebagai berikut:

const authenticationRecord = await credential.authenticate();

authenticationRecord?: AuthenticationRecord

Nilai Properti

AuthenticationRecord

Diwariskan DariInteractiveCredentialOptions.authenticationRecord

authorityHost

Host otoritas yang digunakan untuk permintaan autentikasi. Nilai yang mungkin tersedia melalui AzureAuthorityHosts. Defaultnya adalah "https://login.microsoftonline.com".

authorityHost?: string

Nilai Properti

string

Diwariskan DariInteractiveCredentialOptions.authorityHost

disableAutomaticAuthentication

Membuat getToken melempar jika autentikasi manual diperlukan. Pengembang perlu memanggil ke authenticate() untuk mengontrol kapan harus mengautentikasi secara manual.

disableAutomaticAuthentication?: boolean

Nilai Properti

boolean

Diwariskan DariInteractiveCredentialOptions.disableAutomaticAuthentication

disableInstanceDiscovery

Bidang menentukan apakah penemuan instans dilakukan saat mencoba mengautentikasi. Mengatur ini ke true akan sepenuhnya menonaktifkan penemuan instans dan validasi otoritas. Akibatnya, sangat penting untuk memastikan bahwa host otoritas yang dikonfigurasi valid dan dapat dipercaya. Fungsionalitas ini ditujukan untuk digunakan dalam skenario di mana titik akhir metadata tidak dapat dicapai, seperti di cloud privat atau Azure Stack. Proses penemuan instans memerlukan pengambilan metadata otoritas dari https://login.microsoft.com/ untuk memvalidasi otoritas.

disableInstanceDiscovery?: boolean

Nilai Properti

boolean

Diwariskan DariInteractiveCredentialOptions.disableInstanceDiscovery

httpClient

HttpClient yang akan digunakan untuk mengirim permintaan HTTP.

httpClient?: HttpClient

Nilai Properti

HttpClient

Diwarisi DariInteractiveCredentialOptions.httpClient

loggingOptions

Memungkinkan pengguna untuk mengonfigurasi pengaturan untuk opsi kebijakan pengelogan, memungkinkan informasi akun pengelogan dan informasi identitas pribadi untuk dukungan pelanggan.

loggingOptions?: LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Nilai Properti

LogPolicyOptions & { allowLoggingAccountIdentifiers?: boolean, enableUnsafeSupportLogging?: boolean }

Diwariskan DariInteractiveCredentialOptions.loggingOptions

proxyOptions

Opsi untuk mengonfigurasi proksi untuk permintaan keluar.

proxyOptions?: ProxySettings

Nilai Properti

ProxySettings

Diwariskan DariInteractiveCredentialOptions.proxyOptions

redirectOptions

Opsi untuk bagaimana respons pengalihan ditangani.

redirectOptions?: RedirectPolicyOptions

Nilai Properti

RedirectPolicyOptions

Diwariskan DariInteractiveCredentialOptions.redirectOptions

retryOptions

Opsi yang mengontrol cara mencoba kembali permintaan yang gagal.

retryOptions?: PipelineRetryOptions

Nilai Properti

PipelineRetryOptions

Diwariskan DariInteractiveCredentialOptions.retryOptions

telemetryOptions

Opsi untuk mengatur telemetri umum dan melacak info ke permintaan keluar.

telemetryOptions?: TelemetryOptions

Nilai Properti

TelemetryOptions

Diwariskan DariInteractiveCredentialOptions.telemetryOptions

tlsOptions

Opsi untuk mengonfigurasi autentikasi TLS

tlsOptions?: TlsSettings

Nilai Properti

TlsSettings

Diwariskan DariInteractiveCredentialOptions.tlsOptions

userAgentOptions

Opsi untuk menambahkan detail agen pengguna ke permintaan keluar.

userAgentOptions?: UserAgentPolicyOptions

Nilai Properti

UserAgentPolicyOptions

Diwariskan DariInteractiveCredentialOptions.userAgentOptions