UserFederatedIdentityCredentialParameters 類別

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

實作

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

包含使用者聯合身份憑證(User Federated Identity Credential, user_fic)流程參數的物件。 此系統用於代理身份協定的第 3 段,將從第 2 段取得的聯邦身份憑證交換為用戶範圍的令牌。

可用作參數 acquireToken(UserFederatedIdentityCredentialParameters parameters)

方法摘要

修飾詞與類型 方法與描述
java.lang.String assertion()
static UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)

使用 UPN(使用者主體名稱)的 UserFederatedIdentityCredentialParameters 建構工具。

static UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)

用使用者物件 ID 建構 UserFederatedIdentityCredentialParameters 器。

ClaimsRequest claims()

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

java.lang.String clientClaims()

客戶發起的理賠透過 UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String)設定。

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

已被取代

僅為滿足 IAcquireTokenParameters 介面合約而存在。 不建議使用 — 此 API 預計將涵蓋所有參數類別移除,未來版本將由新機制取代。

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

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

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

java.lang.String tenant()

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

java.lang.String username()
java.util.UUID userObjectId()

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

方法詳細資料

assertion

public String assertion()

傳回:

聯邦身份憑證斷言(JWT)

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)

使用 UPN(使用者主體名稱)的 UserFederatedIdentityCredentialParameters 建構工具。

參數:

scopes - 作用域應用程式正在請求存取權限
username - 目標使用者的 UPN(例如,“user@contoso.com”)
assertion - 從第二段獲得的聯邦身份憑證斷言(JWT)

傳回:

建構器,可用於建構 UserFederatedIdentityCredentialParameters

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)

用使用者物件 ID 建構 UserFederatedIdentityCredentialParameters 器。

參數:

scopes - 作用域應用程式正在請求存取權限
userObjectId - 目標使用者的物件識別碼(OID)
assertion - 從第二段獲得的聯邦身份憑證斷言(JWT)

傳回:

建構器,可用於建構 UserFederatedIdentityCredentialParameters

claims

public ClaimsRequest claims()

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

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

clientClaims

public String clientClaims()

客戶發起的理賠透過 UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String)設定。 作為 OAuth claims 參數轉發到代幣端點,並作為擴展快取金鑰的一部分使用,使不同的宣稱值能分別快取。

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

計算所有快取金鑰元件的擴展快取金鑰雜湊值,或在沒有快取金鑰元件時計算空字串。 由於參數在構造後是不可變的,因此結果會被備忘。

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

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

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

extraQueryParameters


public Map<String,String> extraQueryParameters()

已被取代

僅為滿足 IAcquireTokenParameters 介面合約而存在。 不建議使用 — 此 API 預計將涵蓋所有參數類別移除,未來版本將由新機制取代。

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

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

forceRefresh

public boolean forceRefresh()

傳回:

是否要繞過令牌快取並強制重新請求

scopes

public Set<String> scopes()

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

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

tenant

public String tenant()

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

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

username

public String username()

傳回:

目標使用者的 UPN,或若使用者由物件 ID 識別,則為 null

userObjectId

public UUID userObjectId()

傳回:

目標使用者的物件 ID,或若 UPN 識別使用者為 Null

適用於