ClientApplication class

所有 ClientApplications 的基礎抽象類別 - 公開與機密

方法

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)	透過交換 OAuth2.0 授權碼流程第一步收到的授權碼來取得憑證。 `getAuthCodeUrl(AuthorizationCodeUrlRequest)` 可用於建立 OAuth2.0 授權碼流程第一步的 URL。確保 AuthorizationCodeUrlRequest 與 AuthorizationCodeRequest 中 redirectUri 與範圍的值相同。
acquireTokenByRefreshToken(RefreshTokenRequest)	透過將提供的刷新代幣換成一組新的代幣來取得一個代幣。此 API 僅提供給你想從 ADAL 遷移到 MSAL 的情境。否則，建議你在無聲場景中使用 `acquireTokenSilent()` 。使用 `acquireTokenSilent()`，MSAL 會自動處理代幣的快取與刷新。
acquireTokenByUsernamePassword(UsernamePasswordRequest)	透過交換用戶端應用程式的使用者名稱與密碼來取得憑證並取得密碼授權最新的 OAuth 2.0 安全最佳實務完全禁止密碼授權。關於此建議的更多細節，請參閱 https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 Microsoft 的文件與建議頁面：https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword
acquireTokenSilent(SilentFlowRequest)	當使用者指定該代幣所請求的帳戶時，會悄無聲息地取得該代幣。此 API 預期使用者提供帳號物件，並查看快取以取得該憑證（若有的話）。使用者還可選擇發送「強制刷新」布林值，繞過快取以進行access_token和id_token。若refresh_token過期或找不到，會跳出錯誤，並指引使用者呼叫任何互動式令牌取得 API（例如： `acquireTokenByCode()`）。
clearCache()	清除快取
getAuthCodeUrl(AuthorizationUrlRequest)	建立授權請求的網址，讓使用者輸入憑證並同意應用程式。該 URL 會鎖定應用程式物件中所設定權威的 /authorize 端點。一旦使用者輸入憑證並同意，權威機構會對請求中傳送的重定向 URI 回應，並應包含授權碼，該代碼可透過取得令牌 `acquireTokenByCode(AuthorizationCodeRequest)`。
getLogger()	回傳記錄器實例
getTokenCache()	取得應用程式的標記快取。
setLogger(Logger)	將設定中的預設記錄器替換為新的記錄器，並有新的設定

acquireTokenByCode(AuthorizationCodeRequest, AuthorizationCodePayload)

透過交換 OAuth2.0 授權碼流程第一步收到的授權碼來取得憑證。

getAuthCodeUrl(AuthorizationCodeUrlRequest) 可用於建立 OAuth2.0 授權碼流程第一步的 URL。確保 AuthorizationCodeUrlRequest 與 AuthorizationCodeRequest 中 redirectUri 與範圍的值相同。

function acquireTokenByCode(request: AuthorizationCodeRequest, authCodePayLoad?: AuthorizationCodePayload): Promise<AuthenticationResult>

參數

request: AuthorizationCodeRequest

authCodePayLoad: AuthorizationCodePayload

傳回

Promise<AuthenticationResult>

acquireTokenByRefreshToken(RefreshTokenRequest)

透過將提供的刷新代幣換成一組新的代幣來取得一個代幣。

此 API 僅提供給你想從 ADAL 遷移到 MSAL 的情境。否則，建議你在無聲場景中使用 acquireTokenSilent() 。使用 acquireTokenSilent()，MSAL 會自動處理代幣的快取與刷新。

function acquireTokenByRefreshToken(request: RefreshTokenRequest): Promise<null | AuthenticationResult>

參數

request: RefreshTokenRequest

傳回

Promise<null | AuthenticationResult>

acquireTokenByUsernamePassword(UsernamePasswordRequest)

警告

此 API 現已淘汰。

Use a more secure flow instead

透過交換用戶端應用程式的使用者名稱與密碼來取得憑證並取得密碼授權

最新的 OAuth 2.0 安全最佳實務完全禁止密碼授權。關於此建議的更多細節，請參閱 https://tools.ietf.org/html/draft-ietf-oauth-security-topics-13#section-3.4 Microsoft 的文件與建議頁面：https://docs.microsoft.com/en-us/azure/active-directory/develop/msal-authentication-flows#usernamepassword

function acquireTokenByUsernamePassword(request: UsernamePasswordRequest): Promise<null | AuthenticationResult>

參數

request: UsernamePasswordRequest

UsenamePasswordRequest

傳回

Promise<null | AuthenticationResult>

acquireTokenSilent(SilentFlowRequest)

當使用者指定該代幣所請求的帳戶時，會悄無聲息地取得該代幣。

此 API 預期使用者提供帳號物件，並查看快取以取得該憑證（若有的話）。使用者還可選擇發送「強制刷新」布林值，繞過快取以進行access_token和id_token。若refresh_token過期或找不到，會跳出錯誤，並指引使用者呼叫任何互動式令牌取得 API（例如： acquireTokenByCode()）。

function acquireTokenSilent(request: SilentFlowRequest): Promise<AuthenticationResult>

參數

request: SilentFlowRequest

傳回

Promise<AuthenticationResult>

clearCache()

清除快取

function clearCache()

getAuthCodeUrl(AuthorizationUrlRequest)

建立授權請求的網址，讓使用者輸入憑證並同意應用程式。該 URL 會鎖定應用程式物件中所設定權威的 /authorize 端點。

一旦使用者輸入憑證並同意，權威機構會對請求中傳送的重定向 URI 回應，並應包含授權碼，該代碼可透過取得令牌 acquireTokenByCode(AuthorizationCodeRequest)。

function getAuthCodeUrl(request: AuthorizationUrlRequest): Promise<string>

參數

request: AuthorizationUrlRequest

傳回

Promise<string>

getLogger()

回傳記錄器實例

function getLogger(): Logger

傳回

Logger

getTokenCache()

取得應用程式的標記快取。

function getTokenCache(): TokenCache

傳回

TokenCache

setLogger(Logger)

將設定中的預設記錄器替換為新的記錄器，並有新的設定

function setLogger(logger: Logger)

參數

logger: Logger

記錄器實例