SilentParameters 類別

  • java.lang.Object
    • com.microsoft.aad.msal4j.SilentParameters

實作

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

包含靜默請求參數的物件。 可作為參數 使用 或acquireTokenSilently(SilentParameters parameters)ConfidentialClientApplication#acquireTokenSilently(SilentParameters)

方法摘要

修飾詞與類型 方法與描述
IAccount account()
java.lang.String authorityUrl()
static SilentParametersBuilder builder(Set<String> scopes)

用於無 的情境IAccount(例如某些機密客戶流程或支援預設作業系統帳號的經紀流程)的靜默參數建構器。

static SilentParametersBuilder builder(Set<String> scopes, IAccount account)

靜默參數建構器

ClaimsRequest claims()

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

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

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

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

已被取代

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

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

boolean forceRefresh()
PopParameters proofOfPossession()
java.util.Set<java.lang.String> scopes()

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

java.lang.String tenant()

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

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

方法詳細資料

account

public IAccount account()

authorityUrl

public String authorityUrl()

builder

public static SilentParameters.SilentParametersBuilder builder(Set<String> scopes)

SilentParameters 建構器,適用於包含 的 IAccount情境,例如某些機密客戶流程或支援預設作業系統帳號的經紀流程。

參數:

scopes - 作用域應用程式正在請求存取權限

傳回:

建構器物件,可用於建構 SilentParameters 流程。

builder

public static SilentParameters.SilentParametersBuilder builder(Set<String> scopes, IAccount account)

SilentParameters 建構器

參數:

scopes - 作用域應用程式正在請求存取權限
account - IAccount 為 取得一個令牌

傳回:

建構器物件,可用於建構 SilentParameters。

claims

public ClaimsRequest claims()

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

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

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

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

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

extraQueryParameters


public Map<String,String> extraQueryParameters()

已被取代

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

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

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

forceRefresh

public boolean forceRefresh()

proofOfPossession

public PopParameters proofOfPossession()

scopes

public Set<String> scopes()

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

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

tenant

public String tenant()

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

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

適用於