InteractiveRequestParameters 類別

套件:
com.microsoft.aad.msal4j
Maven 成品:
com.microsoft.azure:msal4j:1.19.1
  • java.lang.Object
    • com.microsoft.aad.msal4j.InteractiveRequestParameters

實作

com.microsoft.aad.msal4j.IAcquireTokenParameters

public class InteractiveRequestParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters

包含互動式請求參數的物件。 可用作參數。acquireToken(InteractiveRequestParameters parameters)

如需詳細資訊，請參閱 https://aka.ms/msal4j-interactive-request。

方法摘要

修飾詞與類型 方法與描述
static InteractiveRequestParametersBuilder builder(URI redirectUri)
ClaimsRequest claims()

透過 OIDC 理賠請求參數請求理賠，允許標準與自訂理賠的請求
java.lang.String claimsChallenge()
java.lang.String domainHint()

提供使用者應該使用租戶或網域登入的提示。
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

為令牌請求新增額外標頭
java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

為令牌請求新增查詢參數
int httpPollingTimeoutInSeconds()

函式庫等待認證結果所需的秒數。
boolean instanceAware()

若設為 true，授權結果將包含使用者家用雲的權限，且此權限將用於令牌請求，而非應用程式中設定的權限。
java.lang.String loginHint()

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

說明所需的使用者互動類型。
PopParameters proofOfPossession()
@lombok.NonNull java.net.URI redirectUri()

重新導向 URI，讓 MSAL 會監聽 Azure AD 回傳的授權碼。
java.util.Set<java.lang.String> scopes()

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

供公共用戶端應用程式使用的集合SystemBrowserOptions
java.lang.String tenant()

覆蓋此請求權限網址中的租戶值
long windowHandle()

用於開啟正確父節點的 UI 元素的父視窗代言人。對於瀏覽器情境及 Windows 主控台應用程式，此值不應被設定。對於 Windows 主控台應用程式，MSAL Java 若未設定此參數，將嘗試發現主控台的視窗代言人。對於使用 MSAL Java 的情境負責開啟 UI 元素（例如使用 MSALRuntime 時），此參數是必需的，若未設定會拋出例外

方法繼承來源 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

方法詳細資料

builder

public static InteractiveRequestParameters.InteractiveRequestParametersBuilder builder(URI redirectUri)

參數:

redirectUri

claims

public ClaimsRequest claims()

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

claimsChallenge

public String claimsChallenge()

domainHint

public String domainHint()

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

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

為令牌請求新增額外標頭

extraQueryParameters

public Map<String,String> extraQueryParameters()

為令牌請求新增查詢參數

httpPollingTimeoutInSeconds

public int httpPollingTimeoutInSeconds()

函式庫等待認證結果所需的秒數。 120 秒是預設逾時，除非此處用其他正整數覆蓋。若此逾時設為 0 或更小，則會被忽略，函式庫改用 1 秒逾時

instanceAware

public boolean instanceAware()

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

loginHint

public String loginHint()

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

prompt

public Prompt prompt()

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

proofOfPossession

public PopParameters proofOfPossession()

redirectUri

public @NonNull URI redirectUri()

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

scopes

public Set<String> scopes()

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

systemBrowserOptions

public SystemBrowserOptions systemBrowserOptions()

PublicClientApplication 將使用的集合SystemBrowserOptions

tenant

public String tenant()

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

windowHandle

public long windowHandle()

用於開啟正確父節點的 UI 元素的父視窗代言人。對於瀏覽器情境及 Windows 主控台應用程式，此值不應被設定。對於 Windows 主控台應用程式，MSAL Java 若未設定此參數，將嘗試發現主控台的視窗代言人。對於使用 MSAL Java 的情境負責開啟 UI 元素（例如使用 MSALRuntime 時），此參數是必需的，若未設定會拋出例外

適用於