PublicClientApplication class

new PublicClientApplication(configuration: Configuration, controller?: IController)

Parameter

Fungsi ini menukarkan kode otorisasi (diteruskan sebagai kode) dari titik akhir token eSTS. Kode otorisasi ini harus diperoleh sisi server menggunakan klien rahasia untuk memperoleh spa_code. API ini tidak ditambahkan untuk akuisisi dan penukaran kode otorisasi normal.

Penukaran kode otorisasi ini tidak akan memerlukan PKCE, karena diperoleh oleh klien rahasia.

function acquireTokenByCode(request: AuthorizationCodeRequest): Promise<AuthenticationResult>

Parameter

Mengembalikan

Janji yang terpenuhi ketika fungsi ini telah selesai, atau ditolak jika kesalahan dimunculkan.

Gunakan saat Anda ingin mendapatkan access_token untuk API Anda melalui membuka jendela popup di browser pengguna

function acquireTokenPopup(request: PopupRequest): Promise<AuthenticationResult>

Parameter

Mengembalikan

Janji yang terpenuhi ketika fungsi ini telah selesai, atau ditolak jika kesalahan dimunculkan.

Gunakan saat Anda ingin mendapatkan access_token untuk API Anda dengan mengalihkan jendela browser pengguna ke titik akhir otorisasi. Fungsi ini mengalihkan halaman, sehingga kode apa pun yang mengikuti fungsi ini tidak akan dijalankan.

PENTING: TIDAK disarankan untuk memiliki kode yang bergantung pada resolusi Janji. Fungsi ini akan menavigasi jauh dari jendela browser saat ini. Saat ini mengembalikan Promise untuk mencerminkan sifat asinkron dari kode yang berjalan dalam fungsi ini.

function acquireTokenRedirect(request: RedirectRequest): Promise<void>

Parameter

Mengembalikan

Secara diam-diam memperoleh token akses untuk serangkaian cakupan tertentu. Mengembalikan janji pemrosesan saat ini jika permintaan paralel dibuat.

function acquireTokenSilent(silentRequest: SilentRequest): Promise<AuthenticationResult>

Parameter

Mengembalikan

• janji yang terpenuhi ketika fungsi ini telah selesai, atau ditolak jika kesalahan dimunculkan. Mengembalikan objek AuthenticationResult

Menambahkan panggilan balik peristiwa ke array

function addEventCallback(callback: EventCallbackFunction, eventTypes?: EventType[]): null | string

Parameter

Mengembalikan

Mendaftarkan panggilan balik untuk menerima peristiwa performa.

function addPerformanceCallback(callback: PerformanceCallbackFunction): string

Parameter

Mengembalikan

Menghapus token dan akun dari cache browser.

function clearCache(logoutRequest?: ClearCacheRequest): Promise<void>

Parameter

Mengembalikan

Membuat StandardController dan meneruskannya ke PublicClientApplication

static function createPublicClientApplication(configuration: Configuration): Promise<IPublicClientApplication>

Parameter

Mengembalikan

Menghapus pendengar peristiwa yang memancarkan peristiwa saat akun pengguna ditambahkan atau dihapus dari localstorage di tab atau jendela browser yang berbeda

function disableAccountStorageEvents()

Menambahkan pendengar peristiwa yang memancarkan peristiwa saat akun pengguna ditambahkan atau dihapus dari localstorage di tab atau jendela browser yang berbeda

function enableAccountStorageEvents()

Mengembalikan akun pertama yang ditemukan di cache yang cocok dengan filter akun yang diteruskan.

function getAccount(accountFilter: AccountFilter): null | AccountInfo

Parameter

Mengembalikan

Akun pertama yang ditemukan di cache yang cocok dengan filter yang disediakan atau null jika tidak ada akun yang dapat ditemukan.

Mengembalikan akun masuk yang cocok dengan homeAccountId. (objek akun dibuat pada saat berhasil masuk) atau null ketika tidak ada akun yang cocok yang ditemukan

function getAccountByHomeId(homeAccountId: string): null | AccountInfo

Parameter

Mengembalikan

Objek akun yang disimpan di MSAL

Mengembalikan akun masuk yang cocok dengan localAccountId. (objek akun dibuat pada saat berhasil masuk) atau null ketika tidak ada akun yang cocok yang ditemukan

function getAccountByLocalId(localId: string): null | AccountInfo

Parameter

Mengembalikan

Objek akun yang disimpan di MSAL

Mengembalikan nama pengguna pencocokan akun yang masuk. (objek akun dibuat pada saat berhasil masuk) atau null ketika tidak ada akun yang cocok yang ditemukan. API ini disediakan untuk kenyamanan tetapi getAccountById harus digunakan untuk keandalan terbaik

function getAccountByUsername(userName: string): null | AccountInfo

Parameter

Mengembalikan

Objek akun yang disimpan di MSAL

Mendapatkan akun yang saat ini aktif

function getActiveAccount(): null | AccountInfo

Mengembalikan

Mengembalikan semua akun dalam cache yang cocok dengan filter opsional. Jika tidak ada filter yang disediakan, semua akun dikembalikan.

function getAllAccounts(accountFilter?: AccountFilter): AccountInfo[]

Parameter

Mengembalikan

Array objek AccountInfo dalam cache

Mengembalikan instans pencatat

function getLogger(): Logger

Mengembalikan

Mendapatkan cache token untuk aplikasi.

function getTokenCache(): ITokenCache

Mengembalikan

Fungsi penanganan aktivitas yang memungkinkan pengguna untuk mengaktifkan peristiwa setelah objek PublicClientApplication dimuat selama alur pengalihan. Ini harus dipanggil pada semua pemuatan halaman yang terlibat dalam alur autentikasi pengalihan.

function handleRedirectPromise(hash?: string): Promise<null | AuthenticationResult>

Parameter

Mengembalikan

Respons token atau null. Jika nilai yang dikembalikan null, maka tidak ada pengalihan autentikasi yang terdeteksi.

Menghidrasi cache dengan token dan akun di objek AuthenticationResult

function hydrateCache(result: AuthenticationResult, request: PopupRequest | RedirectRequest | SilentRequest | Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<void>

Parameter

Mengembalikan

Fungsi initializer untuk melakukan tugas startup asinkron seperti menyambungkan ke ekstensi WAM

function initialize(request?: InitializeApplicationRequest): Promise<void>

Parameter

Mengembalikan

Dipanggil oleh pustaka pembungkus (Angular &React) untuk mengatur SKU dan Versi yang diteruskan ke telemetri, pencatat, dll.

function initializeWrapperLibrary(sku: WrapperSKU, version: string)

Parameter

Gunakan saat memulai proses masuk melalui membuka jendela popup di browser pengguna

function loginPopup(request?: PopupRequest): Promise<AuthenticationResult>

Parameter

Mengembalikan

Janji yang terpenuhi ketika fungsi ini telah selesai, atau ditolak jika kesalahan dimunculkan.

Gunakan saat memulai proses masuk dengan mengalihkan browser pengguna ke titik akhir otorisasi. Fungsi ini mengalihkan halaman, sehingga kode apa pun yang mengikuti fungsi ini tidak akan dijalankan.

PENTING: TIDAK disarankan untuk memiliki kode yang bergantung pada resolusi Janji. Fungsi ini akan menavigasi jauh dari jendela browser saat ini. Saat ini mengembalikan Promise untuk mencerminkan sifat asinkron dari kode yang berjalan dalam fungsi ini.

function loginRedirect(request?: RedirectRequest): Promise<void>

Parameter

Mengembalikan

Fungsi keluar yang tidak digunakan lagi. Gunakan logoutRedirect atau logoutPopup sebagai gantinya

function logout(logoutRequest?: EndSessionRequest): Promise<void>

Parameter

Mengembalikan

Menghapus cache lokal untuk pengguna saat ini lalu membuka jendela popup yang meminta pengguna untuk keluar dari server

function logoutPopup(logoutRequest?: EndSessionPopupRequest): Promise<void>

Parameter

Mengembalikan

Gunakan untuk keluar dari pengguna saat ini, dan alihkan pengguna ke postLogoutRedirectUri. Perilaku default adalah mengalihkan pengguna ke window.location.href.

function logoutRedirect(logoutRequest?: EndSessionRequest): Promise<void>

Parameter

Mengembalikan

Menghapus panggilan balik dengan id yang disediakan dari array panggilan balik

function removeEventCallback(callbackId: string)

Parameter

Menghapus panggilan balik yang terdaftar dengan addPerformanceCallback.

function removePerformanceCallback(callbackId: string): boolean

Parameter

Mengembalikan

Mengatur akun yang akan digunakan sebagai akun aktif. Jika tidak ada akun yang diteruskan ke API acquireToken, maka MSAL akan menggunakan akun aktif ini.

function setActiveAccount(account: null | AccountInfo)

Parameter

Mengganti kumpulan pencatat default dalam konfigurasi dengan Pencatat baru dengan konfigurasi baru

function setLogger(logger: Logger)

Parameter

Mengatur klien navigasi

function setNavigationClient(navigationClient: INavigationClient)

Parameter

Fungsi ini menggunakan iframe tersembunyi untuk mengambil kode otorisasi dari eSTS. Ada kasus di mana ini mungkin tidak berfungsi:

• Browser apa pun yang menggunakan bentuk Pencegahan Pelacakan Cerdas
• Jika tidak ada sesi yang ditetapkan dengan layanan

Dalam kasus ini, permintaan harus dilakukan di dalam popup atau pengalihan bingkai penuh.

Untuk kasus di mana interaksi diperlukan, Anda tidak dapat mengirim permintaan dengan prompt=none.

Jika token refresh Anda telah kedaluwarsa, Anda dapat menggunakan fungsi ini untuk mengambil sekumpulan token baru secara diam-diam selama sesi Anda di server masih ada.

function ssoSilent(request: Partial<Omit<CommonAuthorizationUrlRequest, "responseMode" | "earJwk" | "codeChallenge" | "codeChallengeMethod" | "requestedClaimsHash" | "platformBroker">>): Promise<AuthenticationResult>

Parameter

Mengembalikan

Janji yang terpenuhi ketika fungsi ini telah selesai, atau ditolak jika kesalahan dimunculkan.