InteractiveRequestParameters 類別

  • 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()

取得將隨認證請求發送的理賠請求參數。

java.lang.String claimsChallenge()
java.lang.String domainHint()
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

會獲得額外的 HTTP 標頭,並納入令牌請求中。

java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

已被取代

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

在 token 請求中加入額外的查詢參數。

int httpPollingTimeoutInSeconds()
boolean instanceAware()
java.lang.String loginHint()
Prompt prompt()
PopParameters proofOfPossession()
java.net.URI redirectUri()
java.util.Set<java.lang.String> scopes()

取得存取權杖所請求的範圍(權限)集合。

SystemBrowserOptions systemBrowserOptions()
java.lang.String tenant()

取得令牌請求的租戶識別碼。

long windowHandle()

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

取得將隨認證請求發送的理賠請求參數。

申請參數可用於請求特定權利要求回傳到令牌中、請求多重身份驗證(MFA)認證,或控制令牌發行的其他環節。

claimsChallenge

public String claimsChallenge()

domainHint

public String domainHint()

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

會獲得額外的 HTTP 標頭,並納入令牌請求中。

這些標頭會被加入發送到令牌端點的 HTTP 請求中。 這對於需要自訂標頭作為代理或診斷用途的情境非常有用。

extraQueryParameters


public Map<String,String> extraQueryParameters()

已被取代

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

在 token 請求中加入額外的查詢參數。

這些參數會加入對授權與令牌端點的查詢字串。 這對於需要自訂參數但函式庫未明確支援的情境非常有用。

httpPollingTimeoutInSeconds

public int httpPollingTimeoutInSeconds()

instanceAware

public boolean instanceAware()

loginHint

public String loginHint()

prompt

public Prompt prompt()

proofOfPossession

public PopParameters proofOfPossession()

redirectUri

public URI redirectUri()

scopes

public Set<String> scopes()

取得存取權杖所請求的範圍(權限)集合。

作用域代表應用程式所請求存取的權限。

systemBrowserOptions

public SystemBrowserOptions systemBrowserOptions()

tenant

public String tenant()

取得令牌請求的租戶識別碼。

當指定時,這個值會覆蓋應用程式權限 URL 中指定的租戶。 它可以是租戶 ID(GUID)、網域名稱,或是像「common」或「organizations」這類特殊值。

windowHandle

public long windowHandle()

適用於