InteractiveRequestParameters.InteractiveRequestParametersBuilder 類別

  • java.lang.Object
    • com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder

方法摘要

修飾詞與類型 方法與描述
InteractiveRequestParameters build()
InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

透過 OIDC 理賠請求參數請求理賠,允許標準與自訂理賠的請求

InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

當令牌請求失敗且回應有挑戰字串時使用。

InteractiveRequestParametersBuilder domainHint(String domainHint)

提供使用者應該使用租戶或網域登入的提示。

InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

為令牌請求新增額外標頭

InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

已被取代

不建議用於生產場景。 未來版本會移除此行為,並可能由新的 API 取代。

為令牌請求新增查詢參數

InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

函式庫等待認證結果所需的秒數。

InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

若設為 true,授權結果將包含使用者家用雲的權限,且此權限將用於令牌請求,而非應用程式中設定的權限。

InteractiveRequestParametersBuilder loginHint(String loginHint)

如果你事先知道使用者名稱或電子郵件地址,可以用來預先填入登入頁面的使用者名稱/電子郵件欄位。

InteractiveRequestParametersBuilder prompt(Prompt prompt)

說明所需的使用者互動類型。

InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

設定此請求的 Pop參數,使請求能取得持有證明憑證而非持有人憑證

InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

重新導向 URI,讓 MSAL 會監聽 Azure AD 回傳的授權碼。

InteractiveRequestParametersBuilder scopes(Set<String> scopes)

應用程式請求存取且使用者同意的範圍。

InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

供公共SystemBrowserOptions用戶端應用程式使用的集合

InteractiveRequestParametersBuilder tenant(String tenant)

覆蓋此請求權限網址中的租戶值

java.lang.String toString()
InteractiveRequestParametersBuilder windowHandle(long windowHandle)

父視窗的 handle 用來開啟正確的父 UI 元素

方法繼承來源 java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

方法詳細資料

build

public InteractiveRequestParameters build()

claims

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

透過 OIDC 理賠請求參數請求理賠,允許標準與自訂理賠的請求

參數:

claims

claimsChallenge

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

當令牌請求失敗且回應有挑戰字串時使用。

參數:

claimsChallenge

domainHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(String domainHint)

提供使用者應該使用租戶或網域登入的提示。 網域提示的價值是租戶註冊的網域。

參數:

domainHint

extraHttpHeaders

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

為令牌請求新增額外標頭

參數:

extraHttpHeaders

extraQueryParameters


public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

已被取代

不建議用於生產場景。 未來版本會移除此行為,並可能由新的 API 取代。

為令牌請求新增查詢參數

參數:

extraQueryParameters

httpPollingTimeoutInSeconds

public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

函式庫等待認證結果所需的秒數。 120 秒是預設的超時。

如果這個逾時設為 0 或更小,則會被忽略,函式庫會改用 1 秒的逾時

參數:

httpPollingTimeoutInSeconds

instanceAware

public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

若設為 true,授權結果將包含使用者家用雲的權限,且此權限將用於令牌請求,而非應用程式中設定的權限。

參數:

instanceAware

loginHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(String loginHint)

如果你事先知道使用者名稱或電子郵件地址,可以用來預先填入登入頁面的使用者名稱/電子郵件欄位。 應用程式通常在重新認證時會使用此參數,因為他們已經從先前登入時用preferred_username聲明擷取了使用者名稱。

參數:

loginHint

prompt

public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)

說明所需的使用者互動類型。

參數:

prompt

proofOfPossession

public InteractiveRequestParameters.InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

設定此請求的 PopParameters,允許請求取得持有證明憑證,而非持有憑證

欲了解更多資訊,請參閱 PopParameters 及 https://aka.ms/msal4j-pop

參數:

httpMethod - 有效的 HTTP 方法,例如「GET」或「POST」
uri - 應用程式嘗試存取的下游受保護 API 上的 URI,例如 https://graph.microsoft.com/beta/me/profile
nonce - 字串是透過呼叫資源(例如 Microsoft Graph)未認證,並解析與 pop 認證方案相關的 WWW-Authenticate 標頭並擷取 nonce 參數,或在後續呼叫中解析 Autheticate-Info 標頭並擷取 nextnonce 參數所得到的字串。

redirectUri

public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

重新導向 URI,讓 MSAL 會監聽 Azure AD 回傳的授權碼。 應該是包含埠口的迴圈位址(例如, http://localhost:3671). 若未指定埠口,MSAL 將找到一個開放埠。 如需詳細資訊,請參閱 https://aka.ms/msal4j-interactive-request。

不可為空值。

參數:

redirectUri

scopes

public InteractiveRequestParameters.InteractiveRequestParametersBuilder scopes(Set<String> scopes)

應用程式請求存取且使用者同意的範圍。

參數:

scopes

systemBrowserOptions

public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

PublicClientApplication 將使用的集合SystemBrowserOptions

參數:

systemBrowserOptions

tenant

public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)

覆蓋此請求權限網址中的租戶值

參數:

tenant

toString

public String toString()

覆寫:

InteractiveRequestParameters.InteractiveRequestParametersBuilder.toString()

windowHandle

public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(long windowHandle)

父視窗的 handle 用來開啟正確的父 UI 元素

對於瀏覽器場景和 Windows 控制台應用程式,這個值不應該被設定

對於 Windows 主控台應用程式,若未設定此參數,MSAL Java 會嘗試發現主控台的視窗代言柄

對於由 MSAL Java 負責開啟 UI 元素的情況(例如使用 MSALRuntime 時),此參數是必須的,若未設定會拋出例外

參數:

windowHandle

適用於