ClientApplication class
Kelas abstrak dasar untuk semua ClientApplications - publik dan rahasia
Metode
| acquire |
Memperoleh token dengan bertukar Kode Otorisasi yang diterima dari langkah pertama alur Kode Otorisasi OAuth2.0.
|
| acquire |
Memperoleh token dengan bertukar token refresh yang disediakan untuk sekumpulan token baru. API ini disediakan hanya untuk skenario di mana Anda ingin bermigrasi dari ADAL ke MSAL. Jika tidak, disarankan agar Anda menggunakan |
| acquire |
Memperoleh token dengan pemberian kata sandi dengan bertukar nama pengguna dan kata sandi aplikasi klien untuk kredensial Praktik Terbaik Keamanan OAuth 2.0 terbaru melarang pemberian kata sandi sepenuhnya. Detail selengkapnya tentang rekomendasi ini pada https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 dokumentasi dan rekomendasi Microsoft ada di:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword |
| acquire |
Memperoleh token secara diam-diam ketika pengguna menentukan akun yang diminta token. API ini mengharapkan pengguna untuk menyediakan objek akun dan melihat ke cache untuk mengambil token jika ada.
Ada juga boolean "forceRefresh" opsional yang dapat dikirim pengguna untuk melewati cache untuk access_token dan id_token.
Jika refresh_token kedaluwarsa atau tidak ditemukan, kesalahan dilemparkan dan panduannya adalah agar pengguna memanggil API akuisisi token interaktif (misalnya: |
| clear |
Menghapus cache |
| get |
Membuat URL permintaan otorisasi, membiarkan info masuk input pengguna dan menyetujui aplikasi. URL menargetkan titik akhir /authorize dari otoritas yang dikonfigurasi dalam objek aplikasi. Setelah pengguna memasukkan kredensial dan persetujuan mereka, otoritas akan mengirim respons ke URI pengalihan yang dikirim dalam permintaan dan harus berisi kode otorisasi, yang kemudian dapat digunakan untuk memperoleh token melalui |
| get |
Mengembalikan instans pencatat |
| get |
Mendapatkan cache token untuk aplikasi. |
| set |
Mengganti kumpulan pencatat default dalam konfigurasi dengan Pencatat baru dengan konfigurasi baru |
Detail Metode
acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)
Memperoleh token dengan bertukar Kode Otorisasi yang diterima dari langkah pertama alur Kode Otorisasi OAuth2.0.
getAuthCodeUrl(AuthorizationCodeUrlRequest) dapat digunakan untuk membuat URL untuk langkah pertama alur Kode Otorisasi OAuth2.0. Pastikan bahwa nilai untuk redirectUri dan cakupan di AuthorizationCodeUrlRequest dan AuthorizationCodeRequest sama.
function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>
Parameter
- request
- AuthorizationCodeRequest
- authCodePayLoad
- AuthorizationCodePayload
Mengembalikan
Promise<AuthenticationResult>
acquireTokenByRefreshToken(RefreshTokenRequest)
Memperoleh token dengan bertukar token refresh yang disediakan untuk sekumpulan token baru.
API ini disediakan hanya untuk skenario di mana Anda ingin bermigrasi dari ADAL ke MSAL. Jika tidak, disarankan agar Anda menggunakan acquireTokenSilent() untuk skenario senyap. Saat menggunakan acquireTokenSilent(), MSAL akan menangani penembolokan dan refresh token secara otomatis.
function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>
Parameter
- request
- RefreshTokenRequest
Mengembalikan
Promise<null | AuthenticationResult>
acquireTokenByUsernamePassword(UsernamePasswordRequest)
Peringatan
API ini sudah tidak digunakan lagi.
- Use a more secure flow instead
Memperoleh token dengan pemberian kata sandi dengan bertukar nama pengguna dan kata sandi aplikasi klien untuk kredensial
Praktik Terbaik Keamanan OAuth 2.0 terbaru melarang pemberian kata sandi sepenuhnya. Detail selengkapnya tentang rekomendasi ini pada https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 dokumentasi dan rekomendasi Microsoft ada di:https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>
Parameter
- request
- UsernamePasswordRequest
UsenamePasswordRequest
Mengembalikan
Promise<null | AuthenticationResult>
acquireTokenSilent(SilentFlowRequest)
Memperoleh token secara diam-diam ketika pengguna menentukan akun yang diminta token.
API ini mengharapkan pengguna untuk menyediakan objek akun dan melihat ke cache untuk mengambil token jika ada.
Ada juga boolean "forceRefresh" opsional yang dapat dikirim pengguna untuk melewati cache untuk access_token dan id_token.
Jika refresh_token kedaluwarsa atau tidak ditemukan, kesalahan dilemparkan dan panduannya adalah agar pengguna memanggil API akuisisi token interaktif (misalnya: acquireTokenByCode()).
function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>
Parameter
- request
- SilentFlowRequest
Mengembalikan
Promise<AuthenticationResult>
clearCache()
Menghapus cache
function clearCache()
getAuthCodeUrl(AuthorizationUrlRequest)
Membuat URL permintaan otorisasi, membiarkan info masuk input pengguna dan menyetujui aplikasi. URL menargetkan titik akhir /authorize dari otoritas yang dikonfigurasi dalam objek aplikasi.
Setelah pengguna memasukkan kredensial dan persetujuan mereka, otoritas akan mengirim respons ke URI pengalihan yang dikirim dalam permintaan dan harus berisi kode otorisasi, yang kemudian dapat digunakan untuk memperoleh token melalui acquireTokenByCode(AuthorizationCodeRequest).
function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>
Parameter
- request
- AuthorizationUrlRequest
Mengembalikan
Promise<string>
getLogger()
getTokenCache()
Mendapatkan cache token untuk aplikasi.
function getTokenCache(): TokenCache
Mengembalikan
setLogger(Logger)
Mengganti kumpulan pencatat default dalam konfigurasi dengan Pencatat baru dengan konfigurasi baru
function setLogger(logger: Logger)
Parameter
- logger
- Logger
Instans pencatat