ClientCredentialParameters 類別
- java.
lang. Object - com.
microsoft. aad. msal4j. ClientCredentialParameters
- com.
實作
public class ClientCredentialParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters
包含用戶端憑證流程參數的物件。 可用作參數 acquireToken(ClientCredentialParameters parameters)
方法摘要
| 修飾詞與類型 | 方法與描述 |
|---|---|
|
static
Client |
builder(Set<String> scopes) |
|
Claims |
claims()
取得將隨認證請求發送的理賠請求參數。 |
| java.lang.String |
clientClaims()
客戶發起的理賠透過 ClientCredentialParametersBuilder#claimsFromClient(String)設定。 |
|
IClient |
clientCredential() |
| java.lang.String |
computeExtCacheKeyHash()
計算所有快取金鑰元件的擴展快取金鑰雜湊值。 |
| java.util.Map<java.lang.String,java.lang.String> |
extraHttpHeaders()
會獲得額外的 HTTP 標頭,並納入令牌請求中。 |
| java.util.Map<java.lang.String,java.lang.String> |
extraQueryParameters()
已被取代
不建議用於生產場景。 未來版本會移除此行為,並可能由新的 API 取代。
在 token 請求中加入額外的查詢參數。 |
| java.lang.String |
fmiPath()
取得 FMI(聯邦管理身份)路徑,用於代理身份情境。 |
| java.util.Set<java.lang.String> |
scopes()
取得存取權杖所請求的範圍(權限)集合。 |
| java.lang.Boolean | skipCache() |
| java.lang.String |
tenant()
取得令牌請求的租戶識別碼。 |
方法繼承來源 java.lang.Object
方法詳細資料
builder
public static ClientCredentialParameters.ClientCredentialParametersBuilder builder(Set<String> scopes)
建造者 ClientCredentialParameters
參數:
傳回:
claims
public ClaimsRequest claims()
取得將隨認證請求發送的理賠請求參數。
申請參數可用於請求特定權利要求回傳到令牌中、請求多重身份驗證(MFA)認證,或控制令牌發行的其他環節。
clientClaims
public String clientClaims()
客戶發起的理賠透過 ClientCredentialParametersBuilder#claimsFromClient(String)設定。 作為 OAuth claims 參數轉發到代幣端點,並作為擴展快取金鑰的一部分使用,使不同的宣稱值能分別快取。
clientCredential
public IClientCredential clientCredential()
computeExtCacheKeyHash
public String computeExtCacheKeyHash()
計算所有快取金鑰元件的擴展快取金鑰雜湊值。 若無元件,則回傳空字串。
由於 ClientCredentialParameters 在建構後是不可變的,因此結果會被 memoize 。 同時用於快取寫入(TokenCache)和快取讀取(靜默查找)。
extraHttpHeaders
public Map<String,String> extraHttpHeaders()
會獲得額外的 HTTP 標頭,並納入令牌請求中。
這些標頭會被加入發送到令牌端點的 HTTP 請求中。 這對於需要自訂標頭作為代理或診斷用途的情境非常有用。
extraQueryParameters
public Map<String,String> extraQueryParameters()
已被取代
在 token 請求中加入額外的查詢參數。
這些參數會加入對授權與令牌端點的查詢字串。 這對於需要自訂參數但函式庫未明確支援的情境非常有用。
fmiPath
public String fmiPath()
取得 FMI(聯邦管理身份)路徑,用於代理身份情境。 設定後, fmi_path 會作為客戶端憑證憑證請求中的主體參數,將產生的憑證範圍限定到特定的代理身份。
傳回:
scopes
public Set<String> scopes()
取得存取權杖所請求的範圍(權限)集合。
作用域代表應用程式所請求存取的權限。
skipCache
public Boolean skipCache()
tenant
public String tenant()
取得令牌請求的租戶識別碼。
當指定時,這個值會覆蓋應用程式權限 URL 中指定的租戶。 它可以是租戶 ID(GUID)、網域名稱,或是像「common」或「organizations」這類特殊值。