ClientCredentialParameters.ClientCredentialParametersBuilder 類別

  • java.lang.Object
    • com.microsoft.aad.msal4j.ClientCredentialParameters.ClientCredentialParametersBuilder

public static class ClientCredentialParameters.ClientCredentialParametersBuilder

方法摘要

修飾詞與類型 方法與描述
ClientCredentialParameters build()
ClientCredentialParametersBuilder claims(ClaimsRequest claims)

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

ClientCredentialParametersBuilder claimsFromClient(String claimsJson)

指定客戶端發起的聲明(原始 JSON 物件字串),作為 OAuth claims 請求參數轉發給權杖端點。

ClientCredentialParametersBuilder clientCredential(IClientCredential clientCredential)

會覆寫此請求的用戶端憑證

ClientCredentialParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

為令牌請求新增額外標頭

ClientCredentialParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

已被取代

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

為令牌請求新增查詢參數

ClientCredentialParametersBuilder fmiPath(String fmiPath)

設定代理身份情境的 FMI(聯邦管理身份)路徑。

ClientCredentialParametersBuilder scopes(Set<String> scopes)

Scopes 應用程式正在請求存取權限。

ClientCredentialParametersBuilder skipCache(Boolean skipCache)

指示請求是否應該跳過查閱令牌快取。

ClientCredentialParametersBuilder tenant(String tenant)

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

java.lang.String toString()

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

claims

public ClientCredentialParameters.ClientCredentialParametersBuilder claims(ClaimsRequest claims)

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

參數:

claims

claimsFromClient

public ClientCredentialParameters.ClientCredentialParametersBuilder claimsFromClient(String claimsJson)

指定客戶端發起的聲明(原始 JSON 物件字串),作為 OAuth claims 請求參數轉發給權杖端點。 與 claims(ClaimsRequest claims) (伺服器發出的理賠挑戰,繞過快取)不同,客戶端理賠取得的權杖會被快取,快取條目以理賠值為鍵,因此不同理賠值會產生獨立的快取條目。 使用穩定且非動態的值以避免快取碎片化。 每次請求都傳送相同的值;由於原始值是快取金鑰的一部分,改變或省略它會將請求導向不同的快取分割區。 空白值會被忽略;無效的 JSON 物件會拋 MsalClientException出 。

參數:

claimsJson - 一個有效的 JSON 物件字串,包含客戶端聲明

傳回:

建構器,可用於建構 ClientCredentialParameters。

clientCredential

public ClientCredentialParameters.ClientCredentialParametersBuilder clientCredential(IClientCredential clientCredential)

會覆寫此請求的用戶端憑證

參數:

clientCredential

extraHttpHeaders

public ClientCredentialParameters.ClientCredentialParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

為令牌請求新增額外標頭

參數:

extraHttpHeaders

extraQueryParameters


public ClientCredentialParameters.ClientCredentialParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

已被取代

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

為令牌請求新增查詢參數

參數:

extraQueryParameters

fmiPath

public ClientCredentialParameters.ClientCredentialParametersBuilder fmiPath(String fmiPath)

設定代理身份情境的 FMI(聯邦管理身份)路徑。 設定後,fmi_path會作為客戶端憑證憑證請求中的主體參數,指示 Entra ID 將產生的憑證範圍限定到特定代理身份。 該令牌同時以擴展快取金鑰快取,以防止不同代理身份的令牌間發生碰撞。

參數:

fmiPath - FMI 路徑值(通常是代理應用程式 ID)

傳回:

建構器,可用於建構 ClientCredentialParameters。

scopes

public ClientCredentialParameters.ClientCredentialParametersBuilder scopes(Set<String> scopes)

Scopes 應用程式正在請求存取權限。

不可為空值。

參數:

scopes

skipCache

public ClientCredentialParameters.ClientCredentialParametersBuilder skipCache(Boolean skipCache)

指示請求是否應該跳過查閱令牌快取。 預設是 false。

參數:

skipCache

tenant

public ClientCredentialParameters.ClientCredentialParametersBuilder tenant(String tenant)

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

參數:

tenant

toString

public String toString()

覆寫:

ClientCredentialParameters.ClientCredentialParametersBuilder.toString()

適用於