@azure/msal-browser 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.

BrowserAuthError

Kelas kesalahan pustaka browser yang dilemparkan oleh pustaka MSAL.js untuk SPAs

BrowserConfigurationAuthError

Kelas kesalahan pustaka browser yang dilemparkan oleh pustaka MSAL.js untuk SPAs

BrowserPerformanceClient
BrowserPerformanceMeasurement
ClientAuthError

Kesalahan muncul ketika ada kesalahan dalam kode klien yang berjalan di browser.

ClientConfigurationError

Kesalahan muncul ketika ada kesalahan dalam konfigurasi pustaka MSAL.js.

EventHandler
EventMessageUtils
InteractionRequiredAuthError

Kesalahan muncul saat interaksi pengguna diperlukan.

LocalStorage
Logger

Kelas yang memfasilitasi pengelogan pesan ke tempat tertentu.

MemoryStorage
NavigationClient
PublicClientApplication

Kelas PublicClientApplication adalah objek yang diekspos oleh pustaka untuk melakukan fungsi autentikasi dan otorisasi di Aplikasi Halaman Tunggal untuk mendapatkan token JWT seperti yang dijelaskan dalam Alur Kode Otorisasi OAuth 2.0 dengan spesifikasi PKCE.

PublicClientNext

PublicClientNext adalah tampilan awal dari implementasi PublicClientApplication yang direncanakan dalam versi utama berikutnya dari MSAL.js. Ini berisi dukungan untuk beberapa implementasi API berdasarkan lingkungan runtime yang dijalankannya.

Tujuan dari perubahan ini adalah untuk memberikan pemisahan perilaku yang bersih antara konteks operasi yang berbeda (Nested App Auth, Platform Brokers, Plain old Browser, dll.) sambil tetap menyediakan permukaan API yang konsisten untuk pengembang.

Silakan gunakan PublicClientApplication untuk skenario prod/dunia nyata apa pun. Catatan: PublicClientNext bersifat eksperimental dan dapat merusak perubahan tanpa semver berikut

ServerError

Kesalahan muncul ketika ada kesalahan dengan kode server, misalnya, tidak tersedia.

SessionStorage
SignedHttpRequest
StubPerformanceClient
UrlString

Kelas objek url yang dapat melakukan berbagai transformasi pada string url.

AuthFlowActionRequiredStateBase

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

AuthFlowStateBase

Kelas dasar untuk status alur autentikasi.

AuthMethodRegistrationChallengeMethodError

Kesalahan yang terjadi selama permintaan tantangan metode autentikasi.

AuthMethodRegistrationChallengeMethodResult

Hasil dari menantang metode autentikasi untuk pendaftaran. Menggunakan jenis status dasar untuk menghindari dependensi melingkar.

AuthMethodRegistrationCompletedState

Status yang menunjukkan bahwa alur pendaftaran metode autentikasi telah berhasil diselesaikan.

AuthMethodRegistrationFailedState

Status yang menunjukkan bahwa alur pendaftaran metode autentikasi telah gagal.

AuthMethodRegistrationRequiredState

Status yang menunjukkan bahwa pendaftaran metode autentikasi diperlukan.

AuthMethodRegistrationSubmitChallengeError

Kesalahan yang terjadi selama pengiriman tantangan metode autentikasi.

AuthMethodRegistrationSubmitChallengeResult

Hasil dari mengirimkan tantangan untuk pendaftaran metode autentikasi.

AuthMethodVerificationRequiredState

Status yang menunjukkan bahwa verifikasi diperlukan untuk metode autentikasi yang ditantang.

CustomAuthAccountData
CustomAuthApiError

Kesalahan API Autentikasi Kustom.

CustomAuthError
CustomAuthPublicClientApplication
GetAccessTokenResult
GetAccountError

Kelas kesalahan untuk mendapatkan kesalahan akun.

GetAccountResult
GetCurrentAccountAccessTokenError

Kelas kesalahan untuk mendapatkan kesalahan token akses akun saat ini.

HttpError
InvalidArgumentError
InvalidConfigurationError
MethodNotImplementedError
MfaAwaitingState

Status yang menunjukkan bahwa MFA diperlukan dan menunggu tindakan pengguna. Status ini memungkinkan pengembang untuk menjeda eksekusi sebelum mengirim kode ke email pengguna.

MfaCompletedState

Status yang menunjukkan bahwa alur MFA telah berhasil diselesaikan.

MfaFailedState

Status yang menunjukkan bahwa alur MFA telah gagal.

MfaRequestChallengeError

Kesalahan yang terjadi selama permintaan tantangan MFA.

MfaRequestChallengeResult

Hasil dari meminta tantangan MFA. Menggunakan jenis status dasar untuk menghindari dependensi melingkar.

MfaSubmitChallengeError

Kesalahan yang terjadi selama pengajuan tantangan MFA.

MfaSubmitChallengeResult

Hasil dari mengirimkan tantangan MFA.

MfaVerificationRequiredState

Status yang menunjukkan bahwa verifikasi MFA diperlukan. Tantangan telah dikirim dan pengguna perlu memberikan kode.

MsalCustomAuthError
NoCachedAccountFoundError
ParsedUrlError
ResetPasswordCodeRequiredState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

ResetPasswordCompletedState

Mewakili status yang menunjukkan keberhasilan penyelesaian operasi reset kata sandi.

ResetPasswordError
ResetPasswordFailedState

Status operasi reset kata sandi yang gagal.

ResetPasswordPasswordRequiredState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

ResetPasswordResendCodeError
ResetPasswordResendCodeResult
ResetPasswordStartResult
ResetPasswordState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

ResetPasswordSubmitCodeError
ResetPasswordSubmitCodeResult
ResetPasswordSubmitPasswordError
ResetPasswordSubmitPasswordResult
SignInCodeRequiredState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

SignInCompletedState

Mewakili status selesai dari operasi masuk. Status ini menunjukkan bahwa proses masuk telah berhasil diselesaikan.

SignInContinuationState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

SignInError
SignInFailedState

Mewakili status operasi masuk yang telah gagal.

SignInPasswordRequiredState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

SignInResendCodeError
SignInResendCodeResult
SignInResult
SignInState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

SignInSubmitCodeError
SignInSubmitCodeResult
SignInSubmitPasswordError
SignInSubmitPasswordResult
SignOutError

Kelas kesalahan untuk kesalahan keluar.

SignOutResult
SignUpAttributesRequiredState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

SignUpCodeRequiredState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

SignUpCompletedState

Mewakili status operasi pendaftaran yang berhasil diselesaikan.

SignUpError
SignUpFailedState

Mewakili status operasi pendaftaran yang gagal.

SignUpPasswordRequiredState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

SignUpResendCodeError
SignUpResendCodeResult
SignUpResult
SignUpState

Kelas dasar untuk status tindakan yang di-requri dalam alur autentikasi.

SignUpSubmitAttributesError
SignUpSubmitAttributesResult
SignUpSubmitCodeError
SignUpSubmitCodeResult
SignUpSubmitPasswordError
SignUpSubmitPasswordResult
UnexpectedError
UnsupportedEnvironmentError
UserAccountAttributeError
UserAlreadySignedInError

Antarmuka

IController
ILoggerCallback
INavigationClient
INetworkModule

Antarmuka jaringan klien untuk mengirim permintaan backend.

IPerformanceClient
IPublicClientApplication
ITokenCache
IWindowStorage
AuthMethodDetails

Detail untuk metode autentikasi yang akan didaftarkan.

AuthenticationMethod
ICustomAuthPublicClientApplication

Alias Jenis

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
AuthenticationResult
AuthorizationCodeRequest
AuthorizationUrlRequest

Jenis ini tidak digunakan lagi dan akan dihapus pada pembaruan versi utama berikutnya

AzureCloudOptions

Opsi khusus AzureCloudInstance

  • azureCloudInstance - enum string yang memberikan notasi singkat untuk otoritas soverign dan cloud publik
  • penyewa - provisi untuk memberikan info penyewa
BrokerConnectionEvent

Payload untuk peristiwa BrokerConnectionEstablished

BrowserAuthOptions

Gunakan ini untuk mengonfigurasi opsi autentikasi di objek Konfigurasi

BrowserSystemOptions
BrowserTelemetryOptions

Opsi Telemetri

CacheOptions

Gunakan ini untuk mengonfigurasi opsi konfigurasi cache di bawah ini:

ClearCacheRequest

ClearCacheRequest

  • correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri.
  • account - Objek akun yang akan keluar dari. Semua token yang terkait dengan akun ini akan dihapus.
Configuration

Objek ini memungkinkan Anda untuk mengonfigurasi elemen penting fungsionalitas MSAL dan diteruskan ke konstruktor PublicClientApplication

EndSessionPopupRequest

EndSessionPopupRequest

  • account - Objek akun yang akan keluar dari. Semua token yang terkait dengan akun ini akan dihapus.
  • postLogoutRedirectUri - URI untuk menavigasi ke setelah halaman keluar di dalam popup. Diperlukan untuk memastikan popup dapat ditutup.
  • authority - Otoritas untuk mengirim permintaan keluar ke.
  • 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
  • mainWindowRedirectUri - URI untuk menavigasi jendela utama ke setelah keluar selesai
  • popupWindowAttributes - Atribut jendela popup opsional. popupSize dengan tinggi dan lebar, dan popupPosition dengan atas dan kiri dapat diatur.
  • logoutHint - String yang menentukan akun yang sedang keluar untuk melewati pemilih akun server saat keluar
  • popupWindowParent - Objek jendela opsional untuk digunakan sebagai induk saat membuka jendela popup. Menggunakan global window jika tidak diberikan.
EndSessionRequest

EndSessionRequest

  • account - Objek akun yang akan keluar dari. Semua token yang terkait dengan akun ini akan dihapus.
  • postLogoutRedirectUri - URI untuk menavigasi ke setelah halaman keluar.
  • authority - Otoritas untuk mengirim permintaan keluar ke.
  • 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
  • onRedirectNavigate - Panggilan balik yang akan diteruskan url yang akan dinavigasi MSAL. Mengembalikan false dalam panggilan balik akan menghentikan navigasi.
  • logoutHint - String yang menentukan akun yang sedang keluar untuk melewati pemilih akun server saat keluar
EventCallbackFunction
EventError
EventMessage
EventPayload
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
IdTokenClaims

Ketik yang menjelaskan klaim Token Id yang diketahui oleh MSAL.

InProgressPerformanceEvent
InitializeApplicationRequest

InitializeApplicationRequest: Meminta objek yang diteruskan oleh pengguna untuk menginisialisasi aplikasi

  • correlationId - GUID unik yang ditetapkan per permintaan untuk melacak permintaan end-to-end untuk tujuan telemetri.
LoadTokenOptions
NavigationOptions

Informasi tambahan yang diteruskan ke fungsi navigateInternal dan navigateExternal

NetworkRequestOptions

Opsi yang diizinkan oleh API permintaan jaringan.

NetworkResponse
PerformanceCallbackFunction
PerformanceEvent

Pengukuran performa yang diambil oleh pustaka, termasuk metadata tentang permintaan dan aplikasi.

PopupEvent
PopupPosition
PopupRequest

PopupRequest: Meminta objek yang diteruskan oleh pengguna untuk mengambil Kode dari server (alur pemberian kode otorisasi leg pertama) dengan jendela popup.

  • cakupan - Array cakupan yang diminta aplikasi aksesnya.
  • 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.
  • 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.
  • 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 login_hint atau 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
  • tokenBodyParameters - String untuk merangkai peta parameter isi permintaan token kustom yang ditambahkan ke panggilan /token. Hanya digunakan saat memperbarui token akses.
  • tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token
  • klaim - Dalam kasus di mana admin penyewa Azure AD telah mengaktifkan kebijakan akses bersyarat, dan kebijakan belum terpenuhi, pengecualian akan berisi klaim yang perlu disetujui.
  • nonce - Nilai yang disertakan dalam permintaan yang dikembalikan dalam token id. Nilai unik yang dihasilkan secara acak biasanya digunakan untuk mengurangi serangan pemutaran ulang.
  • popupWindowAttributes - Atribut jendela popup opsional. popupSize dengan tinggi dan lebar, dan popupPosition dengan atas dan kiri dapat diatur.
  • popupWindowParent - Objek jendela opsional untuk digunakan sebagai induk saat membuka jendela popup. Menggunakan global window jika tidak diberikan.
PopupSize
PopupWindowAttributes

Konfigurasi popup untuk mengatur dimensi dan posisi jendela popup

RedirectRequest

RedirectRequest: Meminta objek yang diteruskan oleh pengguna untuk mengambil Kode dari server (alur pemberian kode otorisasi leg pertama) dengan pengalihan halaman penuh.

  • cakupan - Array cakupan yang diminta aplikasi aksesnya.
  • 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.
  • 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.
  • 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 login_hint atau 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
  • tokenBodyParameters - String untuk merangkai peta parameter isi permintaan token kustom yang ditambahkan ke panggilan /token. Hanya digunakan saat memperbarui token akses.
  • tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token
  • klaim - Dalam kasus di mana admin penyewa Azure AD telah mengaktifkan kebijakan akses bersyarat, dan kebijakan belum terpenuhi, pengecualian akan berisi klaim yang perlu disetujui.
  • nonce - Nilai yang disertakan dalam permintaan yang dikembalikan dalam token id. Nilai unik yang dihasilkan secara acak biasanya digunakan untuk mengurangi serangan pemutaran ulang.
  • redirectStartPage - Halaman yang harus dikembalikan setelah loginRedirect atau acquireTokenRedirect. Ini hanya boleh digunakan jika ini berbeda dari redirectUri dan akan default ke halaman yang memulai permintaan. Ketika opsi konfigurasi navigateToLoginRequestUrl diatur ke false, parameter ini akan diabaikan.
  • onRedirectNavigate - Panggilan balik yang akan diteruskan url yang akan dinavigasi MSAL. Mengembalikan false dalam panggilan balik akan menghentikan navigasi.
SignedHttpRequestOptions
SilentRequest

SilentRequest: Meminta objek yang diteruskan oleh pengguna untuk mengambil token dari cache, memperbarui token yang kedaluwarsa dengan token refresh, atau mengambil kode (leg pertama alur pemberian kode otorisasi) dalam iframe tersembunyi.

  • cakupan - Array cakupan yang diminta aplikasi aksesnya.
  • 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.
  • extraQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /authorize. Hanya digunakan saat memperbarui token refresh.
  • tokenBodyParameters - String untuk merangkai peta parameter isi permintaan token kustom yang ditambahkan ke panggilan /token. Hanya digunakan saat memperbarui token akses.
  • tokenQueryParameters - String untuk merangkai peta parameter kueri kustom yang ditambahkan ke panggilan /token. Hanya digunakan saat memperbarui token akses.
  • 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. Hanya digunakan untuk kasus di mana token refresh kedaluwarsa.
  • cacheLookupPolicy - Enum dengan berbagai cara token senyap dapat diambil.
  • prompt - Menunjukkan jenis interaksi pengguna yang diperlukan. none: akan memastikan bahwa pengguna tidak disajikan dengan perintah interaktif apa pun. jika permintaan tidak dapat diselesaikan melalui akses menyeluruh, titik akhir akan mengembalikan kesalahan interaction_required 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.
SsoSilentRequest

Meminta objek yang diteruskan oleh pengguna ke ssoSilent untuk mengambil Kode dari server (alur pemberian kode otorisasi leg pertama)

  • cakupan - Array cakupan aplikasi meminta akses ke (opsional untuk panggilan ssoSilent)
  • 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.
  • 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.
  • 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 login_hint atau 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
  • tokenBodyParameters - String untuk merangkai peta parameter isi permintaan token kustom yang ditambahkan ke panggilan /token. Hanya digunakan saat memperbarui token akses.
  • 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.
TenantProfile

Detail akun yang bervariasi di seluruh penyewa untuk pengguna yang sama

AccessTokenRetrievalInputs
AccountRetrievalInputs
AuthMethodRegistrationChallengeMethodResultState

Ketik definisi untuk kemungkinan status dalam AuthMethodRegistrationChallengeMethodResult.

AuthMethodRegistrationSubmitChallengeResultState

Ketik definisi untuk kemungkinan status dalam AuthMethodRegistrationSubmitChallengeResult.

CustomAuthConfiguration
GetAccessTokenResultState

Status yang mungkin untuk GetAccessTokenResult. Hal ini mencakup:

  • GetAccessTokenCompletedState: Token akses berhasil diambil.
  • GetAccessTokenFailedState: Pengambilan token akses gagal.
GetAccountResultState

Status yang mungkin untuk GetAccountResult. Hal ini mencakup:

  • GetAccountCompletedState: Akun berhasil diambil.
  • GetAccountFailedState: Pengambilan akun gagal.
MfaRequestChallengeResultState

Status yang mungkin untuk MfaRequestChallengeResult. Hal ini mencakup:

  • MfaVerificationRequiredState: Pengguna perlu memverifikasi tantangan mereka.
  • MfailedState: Permintaan MFA gagal.
MfaSubmitChallengeResultState
ResetPasswordInputs
ResetPasswordResendCodeResultState

Status yang mungkin untuk ResetPasswordResendCodeResult. Hal ini mencakup:

  • ResetPasswordCodeRequiredState: Proses reset kata sandi memerlukan kode.
  • ResetPasswordFailedState: Proses reset kata sandi telah gagal.
ResetPasswordStartResultState

Status yang mungkin untuk ResetPasswordStartResult. Hal ini mencakup:

  • ResetPasswordCodeRequiredState: Proses reset kata sandi memerlukan kode.
  • ResetPasswordFailedState: Proses reset kata sandi telah gagal.
ResetPasswordSubmitCodeResultState

Status yang mungkin untuk ResetPasswordSubmitCodeResult. Hal ini mencakup:

  • ResetPasswordPasswordRequiredState: Proses reset kata sandi memerlukan kata sandi.
  • ResetPasswordFailedState: Proses reset kata sandi telah gagal.
ResetPasswordSubmitPasswordResultState

Status yang mungkin untuk ResetPasswordSubmitPasswordResult. Hal ini mencakup:

  • ResetPasswordCompletedState: Proses reset kata sandi telah berhasil diselesaikan.
  • ResetPasswordFailedState: Proses reset kata sandi telah gagal.
SignInInputs
SignInResendCodeResultState

Status yang mungkin untuk SignInResendCodeResult. Hal ini mencakup:

  • SignInCodeRequiredState: Proses masuk memerlukan kode.
  • SignInFailedState: Proses masuk telah gagal.
SignInResultState

Status yang mungkin untuk SignInResult. Hal ini mencakup:

  • SignInCodeRequiredState: Proses masuk memerlukan kode.
  • SignInPasswordRequiredState: Proses masuk memerlukan kata sandi.
  • SignInFailedState: Proses masuk telah gagal.
  • SignInCompletedState: Proses masuk selesai.
  • AuthMethodRegistrationRequiredState: Proses masuk memerlukan pendaftaran metode autentikasi.
  • MfaAwaitingState: Proses masuk memerlukan MFA.
SignInSubmitCodeResultState

Status yang mungkin dari SignInSubmitCodeResult. Hal ini mencakup:

  • SignInCompletedState: Proses masuk telah berhasil diselesaikan.
  • SignInFailedState: Proses masuk telah gagal.
  • AuthMethodRegistrationRequiredState: Pengguna perlu mendaftarkan metode autentikasi.
  • MfaAwaitingState: Pengguna berada dalam status tunggu autentikasi multifaktor (MFA).
SignInSubmitPasswordResultState

Status yang mungkin dari SignInSubmitPasswordResult. Hal ini mencakup:

  • SignInCompletedState: Proses masuk telah berhasil diselesaikan.
  • SignInFailedState: Proses masuk telah gagal.
  • AuthMethodRegistrationRequiredState: Proses masuk memerlukan pendaftaran metode autentikasi.
  • MfaAwaitingState: Proses masuk memerlukan MFA.
SignInWithContinuationTokenInputs
SignOutResultState

Status yang mungkin untuk SignOutResult. Hal ini mencakup:

  • SignOutCompletedState: Operasi keluar berhasil.
  • SignOutFailedState: Operasi keluar gagal.
SignUpInputs
SignUpResendCodeResultState

Status yang mungkin untuk SignUpResendCodeResult. Hal ini mencakup:

  • SignUpCodeRequiredState: Proses pendaftaran memerlukan kode.
  • SignUpFailedState: Proses pendaftaran telah gagal.
SignUpResultState

Status yang mungkin untuk SignUpResult. Hal ini mencakup:

  • SignUpCodeRequiredState: Proses pendaftaran memerlukan kode.
  • SignUpPasswordRequiredState: Proses pendaftaran memerlukan kata sandi.
  • SignUpAttributesRequiredState: Proses pendaftaran memerlukan atribut tambahan.
  • SignUpFailedState: Proses pendaftaran telah gagal.
SignUpSubmitAttributesResultState

Status yang mungkin untuk SignUpSubmitAttributesResult. Hal ini mencakup:

  • SignUpCompletedState: Proses pendaftaran telah berhasil diselesaikan.
  • SignUpFailedState: Proses pendaftaran telah gagal.
SignUpSubmitCodeResultState

Status yang mungkin untuk SignUpSubmitCodeResult. Hal ini mencakup:

  • SignUpPasswordRequiredState: Proses pendaftaran memerlukan kata sandi.
  • SignUpAttributesRequiredState: Proses pendaftaran memerlukan atribut tambahan.
  • SignUpCompletedState: Proses pendaftaran telah berhasil diselesaikan.
  • SignUpFailedState: Proses pendaftaran telah gagal.
SignUpSubmitPasswordResultState

Status yang mungkin untuk SignUpSubmitPasswordResult. Hal ini mencakup:

  • SignUpAttributesRequiredState: Proses pendaftaran memerlukan atribut tambahan.
  • SignUpCompletedState: Proses pendaftaran telah berhasil diselesaikan.
  • SignUpFailedState: Proses pendaftaran telah gagal.
UserAccountAttributes

Enum

InteractionType
PerformanceEvents

Enumerasi operasi yang diinstrumentasikan oleh performanya yang diukur oleh PerformanceClient.

LogLevel

Tingkat pesan log.

Fungsi

createNestablePublicClientApplication(Configuration)

membuat NestedAppAuthController dan meneruskannya ke PublicClientApplication, kembali ke StandardController jika NestedAppAuthController tidak tersedia

createStandardPublicClientApplication(Configuration)

membuat PublicClientApplication menggunakan StandardController

isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)

Memeriksa apakah broker platform tersedia di lingkungan saat ini.

Variabel

ApiId

Kode API untuk tujuan Telemetri. 0-99 Aliran Senyap 800-899 Aliran Kode Autentikasi 900-999 Lain-lain

AuthenticationScheme

Jenis permintaan autentikasi

AzureCloudInstance
BrowserCacheLocation
CacheLookupPolicy
EventType
InteractionStatus

Jenis interaksi saat ini sedang berlangsung. Digunakan dalam peristiwa di pustaka pembungkus untuk memanggil fungsi ketika interaksi tertentu sedang berlangsung atau semua interaksi selesai.

JsonWebTokenTypes
ProtocolMode

Mode protokol yang didukung oleh MSAL.

ServerResponseType

nilai yang diizinkan untuk jenis respons server

WrapperSKU
AuthErrorMessage

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

BrowserAuthErrorMessage

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

BrowserConfigurationAuthErrorMessage

Kelas BrowserAuthErrorMessage 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.

DEFAULT_IFRAME_TIMEOUT_MS
InteractionRequiredAuthErrorMessage

Kesalahan interaksi yang diperlukan yang ditentukan oleh SDK

OIDC_DEFAULT_SCOPES
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"

stubbedPublicClientApplication
version

Detail Fungsi

createNestablePublicClientApplication(Configuration)

membuat NestedAppAuthController dan meneruskannya ke PublicClientApplication, kembali ke StandardController jika NestedAppAuthController tidak tersedia

function createNestablePublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Parameter

configuration
Configuration

Mengembalikan

IPublicClientApplication

createStandardPublicClientApplication(Configuration)

membuat PublicClientApplication menggunakan StandardController

function createStandardPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Parameter

configuration
Configuration

Mengembalikan

IPublicClientApplication

isPlatformBrokerAvailable(LoggerOptions, IPerformanceClient, string, boolean)

Memeriksa apakah broker platform tersedia di lingkungan saat ini.

function isPlatformBrokerAvailable(loggerOptions?: LoggerOptions, perfClient?: IPerformanceClient, correlationId?: string, domConfig?: boolean): Promise<boolean>

Parameter

loggerOptions
LoggerOptions
perfClient
IPerformanceClient
correlationId

string

domConfig

boolean

Mengembalikan

Promise<boolean>

Detail Variabel

ApiId

Kode API untuk tujuan Telemetri. 0-99 Aliran Senyap 800-899 Aliran Kode Autentikasi 900-999 Lain-lain

ApiId: { acquireTokenByCode: 866, acquireTokenPopup: 862, acquireTokenRedirect: 861, acquireTokenSilent_authCode: 864, acquireTokenSilent_silentFlow: 61, handleRedirectPromise: 865, hydrateCache: 963, loadExternalTokens: 964, logout: 961, logoutPopup: 962, ssoSilent: 863 }

Jenis

{ acquireTokenByCode: 866, acquireTokenPopup: 862, acquireTokenRedirect: 861, acquireTokenSilent_authCode: 864, acquireTokenSilent_silentFlow: 61, handleRedirectPromise: 865, hydrateCache: 963, loadExternalTokens: 964, logout: 961, logoutPopup: 962, ssoSilent: 863 }

AuthenticationScheme

Jenis permintaan autentikasi

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

Jenis

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

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" }

BrowserCacheLocation

BrowserCacheLocation: { LocalStorage: "localStorage", MemoryStorage: "memoryStorage", SessionStorage: "sessionStorage" }

Jenis

{ LocalStorage: "localStorage", MemoryStorage: "memoryStorage", SessionStorage: "sessionStorage" }

CacheLookupPolicy

CacheLookupPolicy: { AccessToken: 1, AccessTokenAndRefreshToken: 2, Default: 0, RefreshToken: 3, RefreshTokenAndNetwork: 4, Skip: 5 }

Jenis

{ AccessToken: 1, AccessTokenAndRefreshToken: 2, Default: 0, RefreshToken: 3, RefreshTokenAndNetwork: 4, Skip: 5 }

EventType

EventType: { ACCOUNT_ADDED: "msal:accountAdded", ACCOUNT_REMOVED: "msal:accountRemoved", ACQUIRE_TOKEN_BY_CODE_FAILURE: "msal:acquireTokenByCodeFailure", ACQUIRE_TOKEN_BY_CODE_START: "msal:acquireTokenByCodeStart", ACQUIRE_TOKEN_BY_CODE_SUCCESS: "msal:acquireTokenByCodeSuccess", ACQUIRE_TOKEN_FAILURE: "msal:acquireTokenFailure", ACQUIRE_TOKEN_NETWORK_START: "msal:acquireTokenFromNetworkStart", ACQUIRE_TOKEN_START: "msal:acquireTokenStart", ACQUIRE_TOKEN_SUCCESS: "msal:acquireTokenSuccess", ACTIVE_ACCOUNT_CHANGED: "msal:activeAccountChanged", BROKER_CONNECTION_ESTABLISHED: "msal:brokerConnectionEstablished", HANDLE_REDIRECT_END: "msal:handleRedirectEnd", HANDLE_REDIRECT_START: "msal:handleRedirectStart", INITIALIZE_END: "msal:initializeEnd", INITIALIZE_START: "msal:initializeStart", LOGIN_FAILURE: "msal:loginFailure", LOGIN_START: "msal:loginStart", LOGIN_SUCCESS: "msal:loginSuccess", LOGOUT_END: "msal:logoutEnd", LOGOUT_FAILURE: "msal:logoutFailure", LOGOUT_START: "msal:logoutStart", LOGOUT_SUCCESS: "msal:logoutSuccess", POPUP_OPENED: "msal:popupOpened", RESTORE_FROM_BFCACHE: "msal:restoreFromBFCache", SSO_SILENT_FAILURE: "msal:ssoSilentFailure", SSO_SILENT_START: "msal:ssoSilentStart", SSO_SILENT_SUCCESS: "msal:ssoSilentSuccess" }

Jenis

{ ACCOUNT_ADDED: "msal:accountAdded", ACCOUNT_REMOVED: "msal:accountRemoved", ACQUIRE_TOKEN_BY_CODE_FAILURE: "msal:acquireTokenByCodeFailure", ACQUIRE_TOKEN_BY_CODE_START: "msal:acquireTokenByCodeStart", ACQUIRE_TOKEN_BY_CODE_SUCCESS: "msal:acquireTokenByCodeSuccess", ACQUIRE_TOKEN_FAILURE: "msal:acquireTokenFailure", ACQUIRE_TOKEN_NETWORK_START: "msal:acquireTokenFromNetworkStart", ACQUIRE_TOKEN_START: "msal:acquireTokenStart", ACQUIRE_TOKEN_SUCCESS: "msal:acquireTokenSuccess", ACTIVE_ACCOUNT_CHANGED: "msal:activeAccountChanged", BROKER_CONNECTION_ESTABLISHED: "msal:brokerConnectionEstablished", HANDLE_REDIRECT_END: "msal:handleRedirectEnd", HANDLE_REDIRECT_START: "msal:handleRedirectStart", INITIALIZE_END: "msal:initializeEnd", INITIALIZE_START: "msal:initializeStart", LOGIN_FAILURE: "msal:loginFailure", LOGIN_START: "msal:loginStart", LOGIN_SUCCESS: "msal:loginSuccess", LOGOUT_END: "msal:logoutEnd", LOGOUT_FAILURE: "msal:logoutFailure", LOGOUT_START: "msal:logoutStart", LOGOUT_SUCCESS: "msal:logoutSuccess", POPUP_OPENED: "msal:popupOpened", RESTORE_FROM_BFCACHE: "msal:restoreFromBFCache", SSO_SILENT_FAILURE: "msal:ssoSilentFailure", SSO_SILENT_START: "msal:ssoSilentStart", SSO_SILENT_SUCCESS: "msal:ssoSilentSuccess" }

InteractionStatus

Jenis interaksi saat ini sedang berlangsung. Digunakan dalam peristiwa di pustaka pembungkus untuk memanggil fungsi ketika interaksi tertentu sedang berlangsung atau semua interaksi selesai.

InteractionStatus: { AcquireToken: "acquireToken", HandleRedirect: "handleRedirect", Login: "login", Logout: "logout", None: "none", SsoSilent: "ssoSilent", Startup: "startup" }

Jenis

{ AcquireToken: "acquireToken", HandleRedirect: "handleRedirect", Login: "login", Logout: "logout", None: "none", SsoSilent: "ssoSilent", Startup: "startup" }

JsonWebTokenTypes

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

Jenis

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

ProtocolMode

Mode protokol yang didukung oleh MSAL.

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

Jenis

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

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" }

WrapperSKU

WrapperSKU: { Angular: "@azure/msal-angular", React: "@azure/msal-react" }

Jenis

{ Angular: "@azure/msal-angular", React: "@azure/msal-react" }

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 } }

BrowserAuthErrorMessage

Peringatan

API ini sudah tidak digunakan lagi.

Use exported BrowserAuthErrorCodes instead. In your app you can do :

import { BrowserAuthErrorCodes } from "@azure/msal-browser";

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

BrowserAuthErrorMessage: { authCodeOrNativeAccountRequired: { code: string, desc: string }, authCodeRequired: { code: string, desc: string }, authRequestNotSet: { code: string, desc: string }, blockAcquireTokenInPopupsError: { code: string, desc: string }, blockTokenRequestsInHiddenIframeError: { code: string, desc: string }, cryptoDoesNotExist: { code: string, desc: string }, databaseNotOpen: { code: string, desc: string }, databaseUnavailable: { code: string, desc: string }, emptyNavigateUriError: { code: string, desc: string }, emptyWindowError: { code: string, desc: string }, failedToParseNetworkResponse: { code: string, desc: string }, getRequestFailed: { code: string, desc: string }, hashDoesNotContainKnownPropertiesError: { code: string, desc: string }, hashDoesNotContainStateError: { code: string, desc: string }, hashEmptyError: { code: string, desc: string }, iframeClosedPrematurelyError: { code: string, desc: string }, interactionInProgress: { code: string, desc: string }, invalidBase64StringError: { code: string, desc: string }, invalidCacheType: { code: string, desc: string }, invalidPopTokenRequest: { code: string, desc: string }, monitorIframeTimeoutError: { code: string, desc: string }, monitorPopupTimeoutError: { code: string, desc: string }, nativeConnectionNotEstablished: { code: string, desc: string }, nativeExtensionNotInstalled: { code: string, desc: string }, nativeHandshakeTimeout: { code: string, desc: string }, nativePromptNotSupported: { code: string, desc: string }, noAccountError: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, noTokenRequestCacheError: { code: string, desc: string }, notInBrowserEnvironment: { code: string, desc: string }, pkceNotGenerated: { code: string, desc: string }, popupWindowError: { code: string, desc: string }, postRequestFailed: { code: string, desc: string }, redirectInIframeError: { code: string, desc: string }, signingKeyNotFoundInStorage: { code: string, desc: string }, silentLogoutUnsupportedError: { code: string, desc: string }, silentPromptValueError: { code: string, desc: string }, spaCodeAndNativeAccountPresent: { code: string, desc: string }, stateInteractionTypeMismatchError: { code: string, desc: string }, unableToAcquireTokenFromNativePlatform: { code: string, desc: string }, unableToLoadTokenError: { code: string, desc: string }, unableToParseStateError: { code: string, desc: string }, unableToParseTokenRequestCacheError: { code: string, desc: string }, uninitializedPublicClientApplication: { code: string, desc: string }, userCancelledError: { code: string, desc: string } }

Jenis

{ authCodeOrNativeAccountRequired: { code: string, desc: string }, authCodeRequired: { code: string, desc: string }, authRequestNotSet: { code: string, desc: string }, blockAcquireTokenInPopupsError: { code: string, desc: string }, blockTokenRequestsInHiddenIframeError: { code: string, desc: string }, cryptoDoesNotExist: { code: string, desc: string }, databaseNotOpen: { code: string, desc: string }, databaseUnavailable: { code: string, desc: string }, emptyNavigateUriError: { code: string, desc: string }, emptyWindowError: { code: string, desc: string }, failedToParseNetworkResponse: { code: string, desc: string }, getRequestFailed: { code: string, desc: string }, hashDoesNotContainKnownPropertiesError: { code: string, desc: string }, hashDoesNotContainStateError: { code: string, desc: string }, hashEmptyError: { code: string, desc: string }, iframeClosedPrematurelyError: { code: string, desc: string }, interactionInProgress: { code: string, desc: string }, invalidBase64StringError: { code: string, desc: string }, invalidCacheType: { code: string, desc: string }, invalidPopTokenRequest: { code: string, desc: string }, monitorIframeTimeoutError: { code: string, desc: string }, monitorPopupTimeoutError: { code: string, desc: string }, nativeConnectionNotEstablished: { code: string, desc: string }, nativeExtensionNotInstalled: { code: string, desc: string }, nativeHandshakeTimeout: { code: string, desc: string }, nativePromptNotSupported: { code: string, desc: string }, noAccountError: { code: string, desc: string }, noNetworkConnectivity: { code: string, desc: string }, noTokenRequestCacheError: { code: string, desc: string }, notInBrowserEnvironment: { code: string, desc: string }, pkceNotGenerated: { code: string, desc: string }, popupWindowError: { code: string, desc: string }, postRequestFailed: { code: string, desc: string }, redirectInIframeError: { code: string, desc: string }, signingKeyNotFoundInStorage: { code: string, desc: string }, silentLogoutUnsupportedError: { code: string, desc: string }, silentPromptValueError: { code: string, desc: string }, spaCodeAndNativeAccountPresent: { code: string, desc: string }, stateInteractionTypeMismatchError: { code: string, desc: string }, unableToAcquireTokenFromNativePlatform: { code: string, desc: string }, unableToLoadTokenError: { code: string, desc: string }, unableToParseStateError: { code: string, desc: string }, unableToParseTokenRequestCacheError: { code: string, desc: string }, uninitializedPublicClientApplication: { code: string, desc: string }, userCancelledError: { code: string, desc: string } }

BrowserConfigurationAuthErrorMessage

Peringatan

API ini sudah tidak digunakan lagi.

Use BrowserAuthErrorCodes instead

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

BrowserConfigurationAuthErrorMessage: { inMemRedirectUnavailable: { code: string, desc: string }, storageNotSupportedError: { code: string, desc: string }, stubPcaInstanceCalled: { code: string, desc: string } }

Jenis

{ inMemRedirectUnavailable: { code: string, desc: string }, storageNotSupportedError: { code: string, desc: string }, stubPcaInstanceCalled: { 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 } }

DEFAULT_IFRAME_TIMEOUT_MS

DEFAULT_IFRAME_TIMEOUT_MS: 10000

Jenis

10000

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[]

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 }

stubbedPublicClientApplication

stubbedPublicClientApplication: IPublicClientApplication

Jenis

version

version: "4.30.0"

Jenis

"4.30.0"