@azure/msal-common package

Kelas

AuthError	Kelas kesalahan umum yang dilemparkan oleh pustaka MSAL.js.
AuthenticationHeaderParser	Ini adalah kelas pembantu yang mengurai header autentikasi respons HTTP yang didukung untuk mengekstrak dan mengembalikan nilai tantangan header yang dapat digunakan di luar alur otorisasi dasar.
CacheError	Kesalahan muncul ketika ada kesalahan dengan cache
ClientAuthError	Kesalahan muncul ketika ada kesalahan dalam kode klien yang berjalan di browser.
ClientConfigurationError	Kesalahan muncul ketika ada kesalahan dalam konfigurasi pustaka MSAL.js.
InteractionRequiredAuthError	Kesalahan muncul saat interaksi pengguna diperlukan.
Logger	Kelas yang memfasilitasi pengelogan pesan ke tempat tertentu.
NetworkError	Mewakili kesalahan terkait jaringan
PerformanceClient
PlatformBrokerError	Kelas kesalahan untuk kesalahan MSAL Runtime yang mempertahankan informasi broker terperinci
ProtocolUtils	Kelas yang menyediakan pembantu untuk nilai spesifik protokol OAuth 2.0
ScopeSet	Kelas ScopeSet membuat serangkaian cakupan. Cakupan adalah nilai unik yang tidak peka huruf besar/kecil, sehingga objek Atur di JS paling masuk akal untuk diimplementasikan untuk kelas ini. Semua cakupan dipangkas dan dikonversi ke string huruf kecil dalam fungsi persimpangan dan union untuk memastikan keunikan string.
ServerError	Kesalahan muncul ketika ada kesalahan dengan kode server, misalnya, tidak tersedia.
StubPerformanceClient
UrlString	Kelas objek url yang dapat melakukan berbagai transformasi pada string url.
TokenCacheContext	Instans kelas ini membantu melacak perubahan memori yang memfasilitasi keputusan untuk membaca dan menulis ke cache persisten

Antarmuka

ICrypto	Antarmuka untuk fungsi kripto yang digunakan oleh pustaka
ILoggerCallback
INetworkModule	Antarmuka jaringan klien untuk mengirim permintaan backend.
IPerformanceClient
IPerformanceMeasurement
IUri	Antarmuka yang menjelaskan komponen URI.
PreQueueEvent
IAppTokenProvider
ICachePlugin
IGuidGenerator
INativeBrokerPlugin
ISerializableTokenCache

Alias Jenis

AccessTokenEntity	Jenis cache token akses
AccountFilter	Akun: <home_account_id-environment-realm>><<*>
AccountInfo	Objek akun dengan tanda tangan berikut: homeAccountId - Pengidentifikasi akun beranda untuk objek akun ini environment - Entitas yang mengeluarkan token yang diwakili oleh domain penerbit (misalnya login.microsoftonline.com) tenantId - Penyewa lengkap atau id organisasi tempat akun ini berada nama pengguna - preferred_username klaim id_token yang mewakili akun ini localAccountId - Pengidentifikasi akun lokal khusus penyewa untuk objek akun ini, biasanya digunakan dalam kasus warisan name - Nama lengkap untuk akun, termasuk nama yang diberikan dan nama keluarga idToken - token ID mentah idTokenClaims - Objek berisi klaim dari token ID nativeAccountId - ID akun asli pengguna tenantProfiles - Peta objek profil penyewa untuk setiap penyewa yang telah diautentikasi akun di browser batas data - Batas data yang diekstrak dari clientInfo
ActiveAccountFilters
AppMetadataEntity	Jenis Cache Metadata Aplikasi
ApplicationTelemetry	Informasi telemetri yang dikirim berdasarkan permintaan appName: Nama string unik aplikasi appVersion: Versi aplikasi menggunakan MSAL
AuthenticationResult	Hasil yang dikembalikan dari titik akhir token otoritas. uniqueId - oid atau sub klaim dari token ID tenantId - tid klaim dari token ID cakupan - Cakupan yang divalidasi untuk token masing-masing account - Representasi objek akun dari pengguna yang saat ini masuk idToken - Token id yang diterima sebagai bagian dari respons idTokenClaims - Klaim token ID yang relevan dengan MSAL accessToken - Token akses atau sertifikat SSH yang diterima sebagai bagian dari respons fromCache - Boolean yang menunjukkan apakah token berasal dari cache expiresOn - Objek Tanggal Javascript yang mewakili kedaluwarsa relatif token akses extExpiresOn - Objek Tanggal Javascript yang mewakili kedaluwarsa relatif token akses yang diperpanjang jika terjadi pemadaman server refreshOn - Objek Tanggal Javascript yang mewakili waktu relatif hingga token akses harus di-refresh state - Nilai yang diteruskan oleh pengguna dalam permintaan familyId - Pengidentifikasi ID Keluarga, biasanya hanya digunakan untuk token refresh requestId - ID permintaan dikembalikan sebagai bagian dari respons
AuthorityOptions
AuthorizationCodePayload	Respons dikembalikan setelah memproses string atau fragmen kueri respons kode.
AuthorizeResponse	Properti respons yang dapat dikembalikan oleh titik akhir /authorize
AzureCloudOptions	Opsi khusus AzureCloudInstance azureCloudInstance - enum string yang memberikan notasi singkat untuk otoritas soverign dan cloud publik penyewa - provisi untuk memberikan info penyewa
AzureRegion
AzureRegionConfiguration
BaseAuthRequest	BaseAuthRequest authority - URL otoritas, layanan token keamanan (STS) tempat MSAL akan memperoleh token. Secara default menjadi https://login.microsoftonline.com/common. Jika menggunakan otoritas yang sama untuk semua permintaan, otoritas harus mengatur pada objek aplikasi klien dan bukan permintaan, untuk menghindari penyelesaian titik akhir otoritas beberapa kali. correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri. cakupan - Array cakupan yang diminta aplikasi aksesnya. authenticationScheme - Jenis token yang diambil. Default ke "Pembawa". Dapat juga ketik "pop" atau "SSH". claims - Permintaan klaim ter string yang akan ditambahkan ke semua panggilan /authorize dan /token shrClaims - Objek klaim string yang akan ditambahkan ke Permintaan HTTP yang Ditandatangani shrNonce - Tanda waktu yang dihasilkan server yang telah dienkripsi dan dikodekan base64URL, yang akan ditambahkan ke Permintaan HTTP Yang Ditandatangani. shrOptions - Objek yang berisi opsi untuk Permintaan HTTP yang Ditandatangani 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. sshJwk - Kunci Web JSON yang dibentuk yang mewakili kunci publik yang dapat ditandatangani oleh sertifikat SSH. sshKid - ID Kunci yang secara unik mengidentifikasi kunci umum SSH yang disebutkan di atas. azureCloudOptions - Enum string kenyamanan bagi pengguna untuk menyediakan id cloud publik/berdaulat requestedClaimsHash - STRING hash SHA 256 dari string klaim yang diminta, digunakan sebagai bagian dari kunci cache token akses sehingga token dapat difilter oleh klaim yang diminta tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token tokenBodyParameters - String untuk merangkai peta parameter kustom yang ditambahkan ke isi panggilan /token storeInCache - Objek yang berisi nilai boolean yang menunjukkan apakah akan menyimpan token dalam cache atau tidak (defaultnya adalah true) scenarioId - Id skenario untuk melacak permintaan pengguna kustom popKid - ID Kunci untuk mengidentifikasi kunci publik untuk permintaan token PoP embeddedClientId - Id klien tertanam. Ketika ditentukan, param id klien broker (brk_client_id) dan uri pengalihan (brk_redirect_uri) diatur dengan nilai dari konfigurasi, mengambil alih parameter tambahan yang sesuai, jika ada. httpMethod - Metode HTTP yang digunakan untuk permintaan /authorize. Default ke GET, tetapi dapat diatur ke POST jika permintaan memerlukan parameter isi authorizePostBodyParameters - String untuk merangkai peta parameter kustom yang ditambahkan ke isi panggilan /authorize saat httpMethod diatur ke POST skipBrokerClaims - Ketika true dan alur broker digunakan (misalnya, ketika param broker atau embeddedClientId ada), clientCapabilities dari konfigurasi akan dikecualikan dari klaim; diabaikan untuk alur non-broker.
CacheOptions	Gunakan ini untuk mengonfigurasi preferensi cache kredensial di objek ClientConfiguration claimsBasedCachingEnabled - Mengatur apakah token harus di-cache berdasarkan hash klaim. Secara default adalah false.
CcsCredential
ClientInfo	Objek info klien yang terdiri dari: uid: id pengguna utid: id penyewa xms_tdbr: opsional, hanya untuk penyewa non-AS
CommonAuthorizationCodeRequest	Objek permintaan yang diteruskan oleh pengguna untuk memperoleh token dari server yang bertukar kode otorisasi yang valid (leg kedua alur Kode Otorisasi OAuth2.0) cakupan - Array cakupan yang diminta aplikasi aksesnya. claims - Permintaan klaim ter string yang akan ditambahkan ke semua panggilan /authorize dan /token 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. redirectUri - URI pengalihan aplikasi Anda, tempat otoritas akan dialihkan setelah pengguna memasukkan kredensial dan persetujuan. Ini harus sama persis dengan salah satu URI pengalihan yang Anda daftarkan di portal code - Authorization_code yang diperoleh pengguna di leg pertama alur. codeVerifier - Code_verifier yang sama yang digunakan untuk mendapatkan authorization_code. Diperlukan jika PKCE digunakan dalam permintaan pemberian kode otorisasi. Untuk informasi selengkapnya, lihat PKCE RFC: https://tools.ietf.org/html/rfc7636 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. enableSpaAuthCode - Mengaktifkan akqusisi kode otorisasi spa (hanya klien rahasia) tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token
CommonAuthorizationUrlRequest	Meminta objek yang diteruskan oleh pengguna untuk mengambil Kode dari server (bagian pertama alur pemberian kode otorisasi) cakupan - Array cakupan yang diminta aplikasi aksesnya. claims - Permintaan klaim ter string yang akan ditambahkan ke semua panggilan /authorize dan /token authority - Url otoritas tempat aplikasi memperoleh token. correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri. redirectUri - URI pengalihan tempat respons autentikasi dapat diterima oleh aplikasi Anda. Ini harus sama persis dengan salah satu URI pengalihan yang terdaftar di portal Azure. extraScopesToConsent - Cakupan untuk sumber daya yang berbeda saat pengguna memerlukan persetujuan di muka. responseMode - Menentukan metode yang harus digunakan untuk mengirim hasil autentikasi ke aplikasi Anda. Bisa berupa kueri, form_post, atau fragmen. Jika tidak ada nilai yang diteruskan, nilai defaultnya akan dikueri. codeChallenge - Digunakan untuk mengamankan pemberian kode otorisasi melalui Proof of Key for Code Exchange (PKCE). Untuk informasi selengkapnya, lihat PKCE RCF:https://tools.ietf.org/html/rfc7636 codeChallengeMethod - Metode yang digunakan untuk mengodekan pemverifikasi kode untuk parameter tantangan kode. Bisa "biasa" atau "S256". Jika dikecualikan, tantangan kode diasumsikan sebagai teks biasa. Untuk informasi selengkapnya, lihat PKCE RCF: https://tools.ietf.org/html/rfc7636 state - Nilai yang disertakan dalam permintaan yang juga dikembalikan dalam respons token. Nilai unik yang dihasilkan secara acak biasanya digunakan untuk mencegah serangan pemalsuan permintaan lintas situs. Status ini juga digunakan untuk mengodekan informasi tentang status pengguna di aplikasi sebelum permintaan autentikasi terjadi. prompt - Menunjukkan jenis interaksi pengguna yang diperlukan. login: akan memaksa pengguna untuk memasukkan kredensial mereka pada permintaan tersebut, menipu akses menyeluruh tidak ada: akan memastikan bahwa pengguna tidak disajikan dengan perintah interaktif apa pun. jika permintaan tidak dapat diselesaikan melalui akses menyeluruh, titik akhir akan mengembalikan persetujuan kesalahan interaction_required: akan memicu dialog persetujuan OAuth setelah pengguna masuk, meminta pengguna untuk memberikan izin ke aplikasi select_account: akan mengganggu akses menyeluruh-=pada memberikan pengalaman pemilihan akun yang mencantumkan semua akun dalam sesi atau akun yang diingat atau opsi untuk memilih untuk menggunakan pembuatan akun yang berbeda: akan mengarahkan pengguna ke pengalaman pembuatan akun alih-alih pengalaman masuk no_session: tidak akan membaca token sesi yang ada saat mengautentikasi pengguna. Setelah pengguna berhasil diautentikasi, EVO tidak akan membuat sesi baru untuk pengguna. HANYA UNTUK PENGGUNAAN INTERNAL. account - AccountInfo diperoleh dari getAccount API. Akan digunakan dalam skenario tertentu untuk menghasilkan login_hint jika param loginHint dan sid tidak disediakan. loginHint - Dapat digunakan untuk mengisi bidang nama pengguna/alamat email sebelumnya dari halaman masuk untuk pengguna, jika Anda mengetahui nama pengguna/alamat email sebelumnya. Seringkali aplikasi menggunakan parameter ini selama autentikasi ulang, setelah mengekstrak nama pengguna dari rincian masuk sebelumnya menggunakan klaim preferred_username. sid - ID Sesi, pengidentifikasi unik untuk sesi. Tersedia sebagai klaim opsional pada token ID. domainHint - Memberikan petunjuk tentang penyewa atau domain yang harus digunakan pengguna untuk masuk. Nilai petunjuk domain adalah domain terdaftar untuk penyewa. extraQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /authorize tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token nonce - Nilai yang disertakan dalam permintaan yang dikembalikan dalam token id. Nilai unik yang dihasilkan secara acak biasanya digunakan untuk mengurangi serangan pemutaran ulang. 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.
CommonEndSessionRequest	CommonEndSessionRequest account - Objek akun yang akan keluar dari. Semua token yang terkait dengan akun ini akan dihapus. postLogoutRedirectUri - URI untuk menavigasi ke setelah halaman keluar. correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri. idTokenHint - Token ID yang digunakan oleh B2C untuk memvalidasi keluar jika diperlukan oleh kebijakan state - Nilai yang disertakan dalam permintaan ke titik akhir keluar yang akan dikembalikan dalam string kueri setelah pengalihan keluar pasca keluar logoutHint - String yang menentukan akun yang sedang keluar untuk melewati pemilih akun server saat keluar extraQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /authorize
CommonRefreshTokenRequest	CommonRefreshTokenRequest cakupan - Array cakupan yang diminta aplikasi aksesnya. claims - Permintaan klaim ter string yang akan ditambahkan ke semua panggilan /authorize dan /token authority - URL otoritas, layanan token keamanan (STS) tempat MSAL akan memperoleh token. correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri. refreshToken - Token refresh yang dikembalikan dari permintaan sebelumnya ke Penyedia identitas. 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. forceCache - Paksa MSAL untuk menyimpan respons alur token refresh ketika tidak ada akun di cache. Digunakan untuk skenario migrasi. tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token
CommonSilentFlowRequest	Parameter SilentFlow yang diteruskan oleh pengguna untuk mengambil kredensial secara diam-diam cakupan - Array cakupan yang diminta aplikasi aksesnya. claims - Permintaan klaim string yang akan ditambahkan ke semua panggilan /authorize dan /token. Ketika disertakan pada permintaan senyap, pencarian cache akan dilewati dan token akan disegarkan. authority - Url otoritas tempat aplikasi memperoleh token. correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri. account - Entitas akun untuk mencari kredensial. forceRefresh - Memaksa permintaan senyap untuk melakukan panggilan jaringan jika benar. 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. tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token
CredentialEntity	Jenis Singgahan Kredensial
CredentialFilter	Kredensial: <home_account_id*>-<environment-credential_type-client_id-realm>><><<*>-<target*>-<scheme*>
ExternalTokenResponse	Objek respons yang digunakan untuk memuat token eksternal ke cache. token_type: Menunjukkan nilai jenis token. Satu-satunya jenis yang didukung Azure AD adalah Pembawa. cakupan: Cakupan yang valid untuk access_token. expires_in: Berapa lama token akses valid (dalam detik). id_token: JSON Web Token (JWT). Aplikasi dapat mendekodekan segmen token ini untuk meminta informasi tentang pengguna yang masuk. refresh_token: Token refresh OAuth 2.0. Aplikasi dapat menggunakan token ini memperoleh token akses tambahan setelah token akses saat ini kedaluwarsa. access_token: Token akses yang diminta. Aplikasi dapat menggunakan token ini untuk mengautentikasi ke sumber daya yang aman, seperti API web. client_info: Objek info klien
IdTokenEntity	Jenis Singgahan Token Id
InProgressPerformanceEvent
LibraryStateObject	Ketik yang menentukan objek yang diblokir, dikodekan, dan dikirim dalam nilai status. Berisi yang berikut ini: id - pengidentifikasi unik untuk permintaan ini ts - tanda waktu untuk waktu permintaan dibuat. Digunakan untuk memastikan bahwa kedaluwarsa token tidak dihitung dengan benar. platformState - nilai string yang dikirim dari platform.
LoggerOptions	Gunakan ini untuk mengonfigurasi pengelogan yang dilakukan MSAL, dengan mengonfigurasi opsi pencatat di objek Konfigurasi loggerCallback - Panggilan balik untuk pencatat piiLoggingEnabled - Mengatur apakah pengelogan pii diaktifkan logLevel - Mengatur tingkat di mana pengelogan terjadi correlationId - Mengatur correlationId yang dicetak oleh pencatat
NetworkRequestOptions	Opsi yang diizinkan oleh API permintaan jaringan.
NetworkResponse
OIDCOptions	Opsi untuk mode protokol OIDC.
PerformanceCallbackFunction
PerformanceEvent	Pengukuran performa yang diambil oleh pustaka, termasuk metadata tentang permintaan dan aplikasi.
PkceCodes	Jenis PkceCodes menjelaskan struktur objek yang berisi tantangan kode PKCE dan pasangan pemverifikasi
QueueMeasurement	Jenis pengukuran antrean
RefreshTokenEntity	Refresh Jenis Cache Token
RequestStateObject	Ketik yang menentukan objek yang di string dan dikodekan yang dikirim ke layanan dalam permintaan otorisasi.
RequestThumbprint	Jenis yang mewakili thumbprint permintaan unik.
ServerAuthorizationTokenResponse	Objek respons yang dideserialisasi dari permintaan kode otorisasi server. token_type: Menunjukkan nilai jenis token. Dapat berupa Pembawa atau pop. cakupan: Cakupan yang valid untuk access_token. expires_in: Berapa lama token akses valid (dalam detik). refresh_in: Durasi yang mana token harus diperbarui, terlepas dari kedaluwarsa. ext_expires_in: Berapa lama token akses valid (dalam detik) jika server tidak merespons. access_token: Token akses yang diminta. Aplikasi dapat menggunakan token ini untuk mengautentikasi ke sumber daya yang aman, seperti API web. refresh_token: Token refresh OAuth 2.0. Aplikasi dapat menggunakan token ini memperoleh token akses tambahan setelah token akses saat ini kedaluwarsa. id_token: JSON Web Token (JWT). Aplikasi dapat mendekodekan segmen token ini untuk meminta informasi tentang pengguna yang masuk. key_id: String yang secara unik mengidentifikasi kunci publik tempat permintaan terikat. Jika terjadi kesalahan: kesalahan: String kode kesalahan yang dapat digunakan untuk mengklasifikasikan jenis kesalahan yang terjadi, dan dapat digunakan untuk bereaksi terhadap kesalahan. error_description: Pesan kesalahan tertentu yang dapat membantu pengembang mengidentifikasi akar penyebab kesalahan autentikasi. error_codes: Daftar kode kesalahan khusus STS yang dapat membantu dalam diagnostik. tanda waktu: Waktu terjadinya kesalahan. trace_id: Pengidentifikasi unik untuk permintaan yang dapat membantu dalam diagnostik. correlation_id: Pengidentifikasi unik untuk permintaan yang dapat membantu dalam diagnostik di seluruh komponen. status: status respons permintaan jaringan
ServerTelemetryEntity
ServerTelemetryRequest
ShrOptions
SignedHttpRequest
SignedHttpRequestParameters
StaticAuthorityOptions
StoreInCache	Mengontrol apakah token harus disimpan dalam cache atau tidak. Jika diatur ke false, token mungkin masih diperoleh dan dikembalikan tetapi tidak akan di-cache untuk pengambilan nanti.
StringDict	jenis Key-Value untuk mendukung queryParams, extraQueryParams, dan klaim
SubMeasurement
SystemOptions	Gunakan ini untuk mengonfigurasi info perpanjangan token di objek Konfigurasi tokenRenewalOffsetSeconds - Mengatur jendela offset yang diperlukan untuk memperbarui token sebelum kedaluwarsa
TenantProfile	Detail akun yang bervariasi di seluruh penyewa untuk pengguna yang sama
ThrottlingEntity
TokenClaims	Ketik yang menjelaskan klaim Token Id yang diketahui oleh MSAL.
TokenKeys
AppTokenProviderParameters	Input objek untuk ekstensiblitas IAppTokenProvider. MSAL akan membuat objek ini, yang dapat digunakan untuk membantu membuat AppTokenProviderResult. correlationId - Id korelasi yang terkait dengan permintaan tenantId - Id penyewa tempat token harus disediakan cakupan - cakupan yang tokennya harus disediakan klaim - klaim tambahan apa pun yang harus dipenuhi oleh token
AppTokenProviderResult	Objek output untuk ekstensiblitas IAppTokenProvider. accessToken - token akses aktual, biasanya dalam format JWT, yang memenuhi data permintaan AppTokenProviderParameters expiresInSeconds - berapa lama token sebelum kedaluwarsa, dalam hitungan detik. Mirip dengan bidang "expires_in" dalam respons token AAD. refreshInSeconds - berapa lama token harus disegarkan secara proaktif. Mirip dengan bidang "refresh_in" dalam respons token AAD.
ClientAssertion	Kredensial Pernyataan Klien untuk Klien Rahasia
ClientAssertionCallback
ClientAssertionConfig
CommonClientCredentialRequest	CommonClientCredentialRequest cakupan - Array cakupan yang diminta aplikasi aksesnya. authority - URL otoritas, layanan token keamanan (STS) tempat MSAL akan memperoleh token. correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri. skipCache - Lewati pencarian cache token dan paksa permintaan ke otoritas untuk mendapatkan token baru. Secara default diatur ke false. preferredAzureRegionOptions - Opsi wilayah azure pilihan pengguna tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token
CommonDeviceCodeRequest	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
CommonOnBehalfOfRequest	cakupan - Array cakupan yang diminta aplikasi aksesnya. authority - URL otoritas, layanan token keamanan (STS) tempat MSAL akan memperoleh token. correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri. oboAssertion - Token akses yang dikirim ke API tingkat menengah. Token ini harus memiliki audiens aplikasi yang membuat permintaan OBO ini. skipCache - Lewati pencarian cache token dan paksa permintaan ke otoritas untuk mendapatkan token baru. Secara default diatur ke false. tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token
CommonUsernamePasswordRequest	Parameter CommonUsernamePassword yang diteruskan oleh pengguna untuk mengambil kredensial Catatan: Praktik Terbaik Keamanan OAuth 2.0 terbaru melarang pemberian kata sandi sepenuhnya. Alur ini ditambahkan untuk pengujian internal. cakupan - Array cakupan yang diminta aplikasi aksesnya. claims - Permintaan klaim string yang akan ditambahkan ke semua panggilan /authorize dan /token. Ketika disertakan pada permintaan senyap, pencarian cache akan dilewati dan token akan disegarkan. authority - Url otoritas tempat aplikasi memperoleh token. correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri. nama pengguna - nama pengguna klien password - kredensial tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token
DeviceCodeResponse	DeviceCode dikembalikan oleh titik akhir kode perangkat layanan token keamanan yang berisi informasi yang diperlukan untuk alur kode perangkat. userCode: kode yang perlu disediakan pengguna saat mengautentikasi di URI verifikasi deviceCode: kode yang harus disertakan dalam permintaan untuk token akses verificationUri: URI tempat pengguna dapat mengautentikasi expiresIn: waktu kedaluwarsa kode perangkat dalam hitungan detik interval: interval di mana STS harus dijajaki pesan: pesan yang harus ditampilkan kepada pengguna
NativeRequest
NativeSignOutRequest
ServerDeviceCodeResponse

Enum

LogLevel	Tingkat pesan log.
PerformanceEventStatus	Status peristiwa performa.
PerformanceEvents	Enumerasi operasi yang diinstrumentasikan oleh performanya yang diukur oleh PerformanceClient.

Fungsi

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)
buildClientInfo(string, (input: string) => string)	Fungsi untuk membangun objek info klien dari string clientInfo server
buildClientInfoFromHomeAccountId(string)	Fungsi untuk membangun objek info klien dari string homeAccountId yang di-cache
buildStaticAuthorityOptions(Partial<AuthorityOptions>)
buildTenantProfile(string, string, string, TokenClaims)	Membangun profil penyewa
createAuthError(string, string)
createCacheError(unknown)	Fungsi pembantu untuk membungkus kesalahan browser dalam objek CacheError
createClientAuthError(string, string)
createClientConfigurationError(string)
createInteractionRequiredAuthError(string)	Membuat InteractionRequiredAuthError
createNetworkError(AuthError, number, Record<string, string>, Error)	Membuat objek NetworkError untuk permintaan jaringan yang gagal
formatAuthorityUri(string)
getRequestThumbprint(string, BaseAuthRequest, string)
getTenantIdFromIdTokenClaims(TokenClaims)	Mendapatkan tenantId dari klaim token ID yang tersedia untuk ditetapkan sebagai realm kredensial dengan prioritas berikut: tid - jika token diperoleh dari id penyewa Azure AD akan ada tfp - jika token diperoleh dari tfp penyewa B2C modern harus ada acr - jika token diperoleh dari acr penyewa B2C warisan harus ada Downcased agar sesuai dengan persyaratan perbandingan realm yang tidak peka huruf besar/kecil
tenantIdMatchesHomeTenant(string, string)	Mengembalikan true jika tenantId cocok dengan bagian utid dari homeAccountId
updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)	Mengganti info akun yang bervariasi menurut profil penyewa yang bersumber dari klaim token ID yang diteruskan dengan info akun khusus penyewa

Variabel

AADAuthorityConstants	Konstanta string yang terkait dengan Otoritas AAD
AuthenticationScheme	Jenis permintaan autentikasi
AuthorityType	Jenis otoritas yang didukung oleh MSAL.
AzureCloudInstance
CacheAccountType	Jenis akun di Cache
CacheOutcome	Menentukan alasan untuk mengambil token akses dari IdP
CacheType	Menggabungkan semua jenis cache
CcsCredentialType
ClaimsRequestKeys	Kunci permintaan klaim
CredentialType	Jenis Kredensial yang disimpan dalam cache
EncodingTypes
GrantType	grant_type yang diizinkan
HeaderNames	Meminta nama header
HttpMethod
HttpStatus
JsonWebTokenTypes
OAuthResponseType	Nilai yang diizinkan untuk response_type
PasswordGrantConstants	Parameter pemberian kata sandi
PersistentCacheKeys	Kunci cache persisten MSAL yang tetap ada saat pengguna masuk.
ProtocolMode	Mode protokol yang didukung oleh MSAL.
ResponseMode	nilai yang diizinkan untuk response_mode
ServerResponseType	nilai yang diizinkan untuk jenis respons server
AuthErrorMessage	Kelas AuthErrorMessage yang berisi konstanta string yang digunakan oleh kode kesalahan dan pesan.
ClientAuthErrorMessage	Konstanta string yang digunakan oleh kode kesalahan dan pesan.
ClientConfigurationErrorMessage	Kelas ClientConfigurationErrorMessage yang berisi konstanta string yang digunakan oleh kode kesalahan dan pesan.
CodeChallengeMethodValues	nilai yang diizinkan untuk codeVerifier
Constants
DEFAULT_CRYPTO_IMPLEMENTATION
DEFAULT_SYSTEM_OPTIONS
DEFAULT_TOKEN_RENEWAL_OFFSET_SEC
Errors
IntFields
InteractionRequiredAuthErrorMessage	Kesalahan interaksi yang diperlukan yang ditentukan oleh SDK
OIDC_DEFAULT_SCOPES
ONE_DAY_IN_MS
PromptValue	kami mempertimbangkan untuk membuat "enum" ini dalam permintaan alih-alih string, namun sepertinya daftar nilai prompt yang diizinkan terus berubah selama beberapa tahun terakhir. Ada beberapa nilai prompt yang tidak terdokumentasi untuk beberapa mitra internal juga, oleh karena itu pilihan jenis "string" generik alih-alih "enum"
StubbedNetworkModule
THE_FAMILY_ID
ThrottlingConstants	Konstanta yang terkait dengan pembatasan
version

Detail Fungsi

buildAccountToCache(CacheManager, Authority, string, (input: string) => string, string, TokenClaims, string, string, null | string, AuthorizationCodePayload, string, Logger)

function buildAccountToCache(cacheStorage: CacheManager, authority: Authority, homeAccountId: string, base64Decode: (input: string) => string, correlationId: string, idTokenClaims?: TokenClaims, clientInfo?: string, environment?: string, claimsTenantId?: null | string, authCodePayload?: AuthorizationCodePayload, nativeAccountId?: string, logger?: Logger): AccountEntity

Parameter

cacheStorage

CacheManager

authority

Authority

homeAccountId

string

base64Decode

(input: string) => string

correlationId

string

idTokenClaims

TokenClaims

clientInfo

string

environment

string

claimsTenantId

null | string

authCodePayload

AuthorizationCodePayload

nativeAccountId

string

logger

Logger

Mengembalikan

AccountEntity

buildClientInfo(string, (input: string) => string)

Fungsi untuk membangun objek info klien dari string clientInfo server

function buildClientInfo(rawClientInfo: string, base64Decode: (input: string) => string): ClientInfo

Parameter

rawClientInfo

string

base64Decode

(input: string) => string

Mengembalikan

ClientInfo

buildClientInfoFromHomeAccountId(string)

Fungsi untuk membangun objek info klien dari string homeAccountId yang di-cache

function buildClientInfoFromHomeAccountId(homeAccountId: string): ClientInfo

Parameter

homeAccountId

string

Mengembalikan

ClientInfo

buildStaticAuthorityOptions(Partial<AuthorityOptions>)

function buildStaticAuthorityOptions(authOptions: Partial<AuthorityOptions>): StaticAuthorityOptions

Parameter

authOptions

Partial<AuthorityOptions>

Mengembalikan

StaticAuthorityOptions

buildTenantProfile(string, string, string, TokenClaims)

Membangun profil penyewa

function buildTenantProfile(homeAccountId: string, localAccountId: string, tenantId: string, idTokenClaims?: TokenClaims): TenantProfile

Parameter

homeAccountId

string

Pengidentifikasi akun beranda untuk objek akun ini

localAccountId

string

Pengidentifikasi akun lokal untuk objek akun ini

tenantId

string

Penyewa lengkap atau id organisasi tempat akun ini berada

idTokenClaims

TokenClaims

Klaim dari token ID

Mengembalikan

TenantProfile

createAuthError(string, string)

function createAuthError(code: string, additionalMessage?: string): AuthError

Parameter

code

string

additionalMessage

string

Mengembalikan

AuthError

createCacheError(unknown)

Fungsi pembantu untuk membungkus kesalahan browser dalam objek CacheError

function createCacheError(e: unknown): CacheError

Parameter

e

unknown

Mengembalikan

CacheError

createClientAuthError(string, string)

function createClientAuthError(errorCode: string, additionalMessage?: string): ClientAuthError

Parameter

errorCode

string

additionalMessage

string

Mengembalikan

ClientAuthError

createClientConfigurationError(string)

function createClientConfigurationError(errorCode: string): ClientConfigurationError

Parameter

errorCode

string

Mengembalikan

ClientConfigurationError

createInteractionRequiredAuthError(string)

Membuat InteractionRequiredAuthError

function createInteractionRequiredAuthError(errorCode: string): InteractionRequiredAuthError

Parameter

errorCode

string

Mengembalikan

InteractionRequiredAuthError

createNetworkError(AuthError, number, Record<string, string>, Error)

Membuat objek NetworkError untuk permintaan jaringan yang gagal

function createNetworkError(error: AuthError, httpStatus?: number, responseHeaders?: Record<string, string>, additionalError?: Error): NetworkError

Parameter

error

AuthError

Kesalahan yang akan dilemparkan kembali ke pemanggil

httpStatus

number

Kode status permintaan jaringan

responseHeaders

Record<string, string>

Header respons permintaan jaringan, jika tersedia

additionalError

Error

Mengembalikan

NetworkError

Objek NetworkError

formatAuthorityUri(string)

function formatAuthorityUri(authorityUri: string): string

Parameter

authorityUri

string

Mengembalikan

string

getRequestThumbprint(string, BaseAuthRequest, string)

function getRequestThumbprint(clientId: string, request: BaseAuthRequest, homeAccountId?: string): RequestThumbprint

Parameter

clientId

string

request

BaseAuthRequest

homeAccountId

string

Mengembalikan

RequestThumbprint

getTenantIdFromIdTokenClaims(TokenClaims)

Mendapatkan tenantId dari klaim token ID yang tersedia untuk ditetapkan sebagai realm kredensial dengan prioritas berikut:

1. tid - jika token diperoleh dari id penyewa Azure AD akan ada
2. tfp - jika token diperoleh dari tfp penyewa B2C modern harus ada
3. acr - jika token diperoleh dari acr penyewa B2C warisan harus ada Downcased agar sesuai dengan persyaratan perbandingan realm yang tidak peka huruf besar/kecil

function getTenantIdFromIdTokenClaims(idTokenClaims?: TokenClaims): string | null

Parameter

idTokenClaims

TokenClaims

Mengembalikan

string | null

tenantIdMatchesHomeTenant(string, string)

Mengembalikan true jika tenantId cocok dengan bagian utid dari homeAccountId

function tenantIdMatchesHomeTenant(tenantId?: string, homeAccountId?: string): boolean

Parameter

tenantId

string

homeAccountId

string

Mengembalikan

boolean

updateAccountTenantProfileData(AccountInfo, TenantProfile, TokenClaims, string)

Mengganti info akun yang bervariasi menurut profil penyewa yang bersumber dari klaim token ID yang diteruskan dengan info akun khusus penyewa

function updateAccountTenantProfileData(baseAccountInfo: AccountInfo, tenantProfile?: TenantProfile, idTokenClaims?: TokenClaims, idTokenSecret?: string): AccountInfo

Parameter

baseAccountInfo

AccountInfo

tenantProfile

TenantProfile

idTokenClaims

TokenClaims

idTokenSecret

string

Mengembalikan

AccountInfo

Detail Variabel

AADAuthorityConstants

Konstanta string yang terkait dengan Otoritas AAD

AADAuthorityConstants: { COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

Jenis

{ COMMON: "common", CONSUMERS: "consumers", ORGANIZATIONS: "organizations" }

AuthenticationScheme

Jenis permintaan autentikasi

AuthenticationScheme: { BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

Jenis

{ BEARER: "Bearer", POP: "pop", SSH: "ssh-cert" }

AuthorityType

Jenis otoritas yang didukung oleh MSAL.

AuthorityType: { Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

Jenis

{ Adfs: 1, Ciam: 3, Default: 0, Dsts: 2 }

AzureCloudInstance

AzureCloudInstance: { AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }

Jenis

{ AzureChina: "https://login.chinacloudapi.cn", AzureGermany: "https://login.microsoftonline.de", AzurePpe: "https://login.windows-ppe.net", AzurePublic: "https://login.microsoftonline.com", AzureUsGovernment: "https://login.microsoftonline.us", None: "none" }

CacheAccountType

Jenis akun di Cache

CacheAccountType: { ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

Jenis

{ ADFS_ACCOUNT_TYPE: "ADFS", GENERIC_ACCOUNT_TYPE: "Generic", MSAV1_ACCOUNT_TYPE: "MSA", MSSTS_ACCOUNT_TYPE: "MSSTS" }

CacheOutcome

Menentukan alasan untuk mengambil token akses dari IdP

CacheOutcome: { CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

Jenis

{ CACHED_ACCESS_TOKEN_EXPIRED: "3", FORCE_REFRESH_OR_CLAIMS: "1", NOT_APPLICABLE: "0", NO_CACHED_ACCESS_TOKEN: "2", PROACTIVELY_REFRESHED: "4" }

CacheType

Menggabungkan semua jenis cache

CacheType: { ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

Jenis

{ ACCESS_TOKEN: 2001, ADFS: 1001, APP_METADATA: 3001, GENERIC: 1004, ID_TOKEN: 2003, MSA: 1002, MSSTS: 1003, REFRESH_TOKEN: 2002, UNDEFINED: 9999 }

CcsCredentialType

CcsCredentialType: { HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

Jenis

{ HOME_ACCOUNT_ID: "home_account_id", UPN: "UPN" }

ClaimsRequestKeys

Kunci permintaan klaim

ClaimsRequestKeys: { ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

Jenis

{ ACCESS_TOKEN: "access_token", XMS_CC: "xms_cc" }

CredentialType

Jenis Kredensial yang disimpan dalam cache

CredentialType: { ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

Jenis

{ ACCESS_TOKEN: "AccessToken", ACCESS_TOKEN_WITH_AUTH_SCHEME: "AccessToken_With_AuthScheme", ID_TOKEN: "IdToken", REFRESH_TOKEN: "RefreshToken" }

EncodingTypes

EncodingTypes: { BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

Jenis

{ BASE64: "base64", HEX: "hex", UTF8: "utf-8" }

GrantType

grant_type yang diizinkan

GrantType: { AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

Jenis

{ AUTHORIZATION_CODE_GRANT: "authorization_code", CLIENT_CREDENTIALS_GRANT: "client_credentials", DEVICE_CODE_GRANT: "device_code", IMPLICIT_GRANT: "implicit", JWT_BEARER: "urn:ietf:params:oauth:grant-type:jwt-bearer", REFRESH_TOKEN_GRANT: "refresh_token", RESOURCE_OWNER_PASSWORD_GRANT: "password" }

HeaderNames

Meminta nama header

HeaderNames: { AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

Jenis

{ AuthenticationInfo: "Authentication-Info", CCS_HEADER: "X-AnchorMailbox", CONTENT_LENGTH: "Content-Length", CONTENT_TYPE: "Content-Type", RETRY_AFTER: "Retry-After", WWWAuthenticate: "WWW-Authenticate", X_MS_HTTP_VERSION: "x-ms-httpver", X_MS_REQUEST_ID: "x-ms-request-id" }

HttpMethod

HttpMethod: { GET: "GET", POST: "POST" }

Jenis

{ GET: "GET", POST: "POST" }

HttpStatus

HttpStatus: { BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

Jenis

{ BAD_REQUEST: 400, CLIENT_ERROR: 400, CLIENT_ERROR_RANGE_END: 499, CLIENT_ERROR_RANGE_START: 400, GATEWAY_TIMEOUT: 504, GONE: 410, MULTI_SIDED_ERROR: 600, NOT_FOUND: 404, REDIRECT: 302, REQUEST_TIMEOUT: 408, SERVER_ERROR: 500, SERVER_ERROR_RANGE_END: 599, SERVER_ERROR_RANGE_START: 500, SERVICE_UNAVAILABLE: 503, SUCCESS: 200, SUCCESS_RANGE_END: 299, SUCCESS_RANGE_START: 200, TOO_MANY_REQUESTS: 429, UNAUTHORIZED: 401 }

JsonWebTokenTypes

JsonWebTokenTypes: { Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

Jenis

{ Jwk: "JWK", Jwt: "JWT", Pop: "pop" }

OAuthResponseType

Nilai yang diizinkan untuk response_type

OAuthResponseType: { CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

Jenis

{ CODE: "code", IDTOKEN_TOKEN: "id_token token", IDTOKEN_TOKEN_REFRESHTOKEN: "id_token token refresh_token" }

PasswordGrantConstants

Parameter pemberian kata sandi

PasswordGrantConstants: { password: "password", username: "username" }

Jenis

{ password: "password", username: "username" }

PersistentCacheKeys

Kunci cache persisten MSAL yang tetap ada saat pengguna masuk.

PersistentCacheKeys: { ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

Jenis

{ ACTIVE_ACCOUNT_FILTERS: "active-account-filters" }

ProtocolMode

Mode protokol yang didukung oleh MSAL.

ProtocolMode: { AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

Jenis

{ AAD: "AAD", EAR: "EAR", OIDC: "OIDC" }

ResponseMode

nilai yang diizinkan untuk response_mode

ResponseMode: { FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }

Jenis

{ FORM_POST: "form_post", FRAGMENT: "fragment", QUERY: "query" }

ServerResponseType

Peringatan

API ini sudah tidak digunakan lagi.

Use ResponseMode instead

nilai yang diizinkan untuk jenis respons server

ServerResponseType: { FRAGMENT: "fragment", QUERY: "query" }

Jenis

{ FRAGMENT: "fragment", QUERY: "query" }

AuthErrorMessage

Peringatan

API ini sudah tidak digunakan lagi.

Use AuthErrorCodes instead

Kelas AuthErrorMessage yang berisi konstanta string yang digunakan oleh kode kesalahan dan pesan.

AuthErrorMessage: { postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

Jenis

{ postRequestFailed: { code: string, desc: string }, unexpectedError: { code: string, desc: string } }

ClientAuthErrorMessage

Peringatan

API ini sudah tidak digunakan lagi.

Use ClientAuthErrorCodes instead

Konstanta string yang digunakan oleh kode kesalahan dan pesan.

ClientAuthErrorMessage: { DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }

Jenis

{ DeviceCodeExpired: { code: string, desc: string }, DeviceCodePollingCancelled: { code: string, desc: string }, DeviceCodeUnknownError: { code: string, desc: string }, NoAccountInSilentRequest: { code: string, desc: string }, appendScopeSetError: { code: string, desc: string }, authTimeNotFoundError: { code: string, desc: string }, bindingKeyNotRemovedError: { code: string, desc: string }, clientInfoDecodingError: { code: string, desc: string }, clientInfoEmptyError: { code: string, desc: string }, emptyInputScopeSetError: { code: string, desc: string }, endpointResolutionError: { code: string, desc: string }, hashNotDeserialized: { code: string, desc: string }, invalidAssertion: { code: string, desc: string }, invalidCacheEnvironment: { code: string, desc: string }, invalidCacheRecord: { code: string, desc: string }, invalidClientCredential: { code: string, desc: string }, invalidStateError: { code: string, desc: string }, keyIdMissing: { code: string, desc: string }, logoutNotSupported: { code: string, desc: string }, maxAgeTranspired: { code: string, desc: string }, missingTenantIdError: { code: string, desc: string }, multipleMatchingAccounts: { code: string, desc: string }, multipleMatchingAppMetadata: { code: string, desc: string }, multipleMatchingTokens: { code: string, desc: string }, nestedAppAuthBridgeDisabled: { code: string, desc: string }, networkError: { code: string, desc: string }, noAccountFound: { code: string, desc: string }, noAuthorizationCodeFromServer: { code: string, desc: string }, noCryptoObj: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, nonceMismatchError: { code: string, desc: string }, nullOrEmptyToken: { code: string, desc: string }, platformBrokerError: { code: string, desc: string }, removeEmptyScopeError: { code: string, desc: string }, stateMismatchError: { code: string, desc: string }, stateNotFoundError: { code: string, desc: string }, tokenClaimsRequired: { code: string, desc: string }, tokenParsingError: { code: string, desc: string }, tokenRefreshRequired: { code: string, desc: string }, tokenRequestCannotBeMade: { code: string, desc: string }, unableToGetOpenidConfigError: { code: string, desc: string }, unexpectedCredentialType: { code: string, desc: string }, userCanceledError: { code: string, desc: string }, userTimeoutReached: { code: string, desc: string } }

ClientConfigurationErrorMessage

Peringatan

API ini sudah tidak digunakan lagi.

Use ClientConfigurationErrorCodes instead

Kelas ClientConfigurationErrorMessage yang berisi konstanta string yang digunakan oleh kode kesalahan dan pesan.

ClientConfigurationErrorMessage: { authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }

Jenis

{ authorityMismatch: { code: string, desc: string }, authorityUriInsecure: { code: string, desc: string }, cannotAllowPlatformBroker: { code: string, desc: string }, cannotSetOIDCOptions: { code: string, desc: string }, claimsRequestParsingError: { code: string, desc: string }, emptyScopesError: { code: string, desc: string }, invalidAuthenticationHeader: { code: string, desc: string }, invalidAuthorityMetadata: { code: string, desc: string }, invalidAuthorizePostBodyParameters: { code: string, desc: string }, invalidClaimsRequest: { code: string, desc: string }, invalidCloudDiscoveryMetadata: { code: string, desc: string }, invalidCodeChallengeMethod: { code: string, desc: string }, invalidCodeChallengeParams: { code: string, desc: string }, invalidPlatformBrokerConfiguration: { code: string, desc: string }, invalidRequestMethodForEAR: { code: string, desc: string }, logoutRequestEmptyError: { code: string, desc: string }, missingNonceAuthenticationHeader: { code: string, desc: string }, missingSshJwk: { code: string, desc: string }, missingSshKid: { code: string, desc: string }, redirectUriNotSet: { code: string, desc: string }, tokenRequestEmptyError: { code: string, desc: string }, untrustedAuthority: { code: string, desc: string }, urlEmptyError: { code: string, desc: string }, urlParseError: { code: string, desc: string } }

CodeChallengeMethodValues

nilai yang diizinkan untuk codeVerifier

CodeChallengeMethodValues: { PLAIN: string, S256: string }

Jenis

{ PLAIN: string, S256: string }

Constants

Constants: { AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

Jenis

{ AAD_INSTANCE_DISCOVERY_ENDPT: string, AAD_TENANT_DOMAIN_SUFFIX: string, ADFS: string, AUTHORIZATION_PENDING: string, AZURE_REGION_AUTO_DISCOVER_FLAG: string, CIAM_AUTH_URL: string, CLAIMS: string, CODE_GRANT_TYPE: string, CONSUMER_UTID: string, DEFAULT_AUTHORITY: string, DEFAULT_AUTHORITY_HOST: string, DEFAULT_COMMON_TENANT: string, DSTS: string, EMAIL_SCOPE: string, EMPTY_STRING: string, FORWARD_SLASH: string, IMDS_ENDPOINT: string, IMDS_TIMEOUT: number, IMDS_VERSION: string, INVALID_INSTANCE: string, KNOWN_PUBLIC_CLOUDS: string[], LIBRARY_NAME: string, NOT_APPLICABLE: string, NOT_AVAILABLE: string, NOT_DEFINED: string, NO_ACCOUNT: string, OFFLINE_ACCESS_SCOPE: string, OPENID_SCOPE: string, PROFILE_SCOPE: string, REGIONAL_AUTH_PUBLIC_CLOUD_SUFFIX: string, RESOURCE_DELIM: string, RT_GRANT_TYPE: string, S256_CODE_CHALLENGE_METHOD: string, SHR_NONCE_VALIDITY: number, SKU: string, URL_FORM_CONTENT_TYPE: string }

DEFAULT_CRYPTO_IMPLEMENTATION

DEFAULT_CRYPTO_IMPLEMENTATION: ICrypto

Jenis

ICrypto

DEFAULT_SYSTEM_OPTIONS

DEFAULT_SYSTEM_OPTIONS: Required<SystemOptions>

Jenis

Required<SystemOptions>

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC

DEFAULT_TOKEN_RENEWAL_OFFSET_SEC: 300

Jenis

300

Errors

Errors: { CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

Jenis

{ CLIENT_MISMATCH_ERROR: string, INVALID_GRANT_ERROR: string }

IntFields

IntFields: ReadonlySet<string>

Jenis

ReadonlySet<string>

InteractionRequiredAuthErrorMessage

Peringatan

API ini sudah tidak digunakan lagi.

Use InteractionRequiredAuthErrorCodes instead

Kesalahan interaksi yang diperlukan yang ditentukan oleh SDK

InteractionRequiredAuthErrorMessage: { bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }

Jenis

{ bad_token: { code: string, desc: string }, interrupted_user: { code: string, desc: string }, native_account_unavailable: { code: string, desc: string }, noTokensFoundError: { code: string, desc: string } }

OIDC_DEFAULT_SCOPES

OIDC_DEFAULT_SCOPES: string[]

Jenis

string[]

ONE_DAY_IN_MS

ONE_DAY_IN_MS: 86400000

Jenis

86400000

PromptValue

kami mempertimbangkan untuk membuat "enum" ini dalam permintaan alih-alih string, namun sepertinya daftar nilai prompt yang diizinkan terus berubah selama beberapa tahun terakhir. Ada beberapa nilai prompt yang tidak terdokumentasi untuk beberapa mitra internal juga, oleh karena itu pilihan jenis "string" generik alih-alih "enum"

PromptValue: { CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

Jenis

{ CONSENT: string, CREATE: string, LOGIN: string, NONE: string, NO_SESSION: string, SELECT_ACCOUNT: string }

StubbedNetworkModule

StubbedNetworkModule: INetworkModule

Jenis

INetworkModule

THE_FAMILY_ID

THE_FAMILY_ID: "1"

Jenis

"1"

ThrottlingConstants

Konstanta yang terkait dengan pembatasan

ThrottlingConstants: { DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

Jenis

{ DEFAULT_MAX_THROTTLE_TIME_SECONDS: number, DEFAULT_THROTTLE_TIME_SECONDS: number, THROTTLING_PREFIX: string, X_MS_LIB_CAPABILITY_VALUE: string }

version

version: "15.17.0"

Jenis

"15.17.0"