AuthorizationCodeParameters.AuthorizationCodeParametersBuilder 類別

  • java.lang.Object
    • com.microsoft.aad.msal4j.AuthorizationCodeParameters.AuthorizationCodeParametersBuilder

public static class AuthorizationCodeParameters.AuthorizationCodeParametersBuilder

方法摘要

修飾詞與類型 方法與描述
AuthorizationCodeParametersBuilder authorizationCode(String authorizationCode)

授權碼於 OAuth2.0 授權碼流程的第一步取得。

AuthorizationCodeParameters build()
AuthorizationCodeParametersBuilder claims(ClaimsRequest claims)

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

AuthorizationCodeParametersBuilder claimsFromClient(String claimsJson)

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

AuthorizationCodeParametersBuilder codeVerifier(String codeVerifier)

用於 PKCE 的程式碼驗證器。

AuthorizationCodeParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

為令牌請求新增額外標頭

AuthorizationCodeParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

已被取代

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

為令牌請求新增查詢參數

AuthorizationCodeParametersBuilder redirectUri(URI redirectUri)

重定向 Azure 入口網站註冊的 URI,該 URI 用於 OAuth2.0 授權碼流程的第一步。

AuthorizationCodeParametersBuilder scopes(Set<String> scopes)

應用程式請求存取權限的範圍

AuthorizationCodeParametersBuilder 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

方法詳細資料

authorizationCode

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder authorizationCode(String authorizationCode)

授權碼於 OAuth2.0 授權碼流程的第一步取得。 如需詳細資訊,請參閱 https://aka.ms/msal4j-authorization-code-flow

不可為空值。

參數:

authorizationCode

build

public AuthorizationCodeParameters build()

claims

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder claims(ClaimsRequest claims)

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

參數:

claims

claimsFromClient

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder claimsFromClient(String claimsJson)

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

客戶端聲明主要用於機密客戶端網頁應用程式,但 AuthorizationCodeParameters 也被 PublicClientApplication接受,因此此方法在該網頁應用中也可見。 兩種 應用程式類型 都適用相同的快取注意事項:透過客戶端主張取得的權杖會儲存在擴展快取金鑰下,而後續 acquireTokenSilently 呼叫(使用 SilentParameters 且無法攜帶客戶端權利)則不會匹配該條目,而是會重新整理,而不會有客戶端權利。 權利要求僅適用於設定權利的收購/贖回呼叫;要再次套用,請透過這個建構器兌換,而不是依賴無聲的刷新。

參數:

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

傳回:

此建構實例

codeVerifier

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder codeVerifier(String codeVerifier)

用於 PKCE 的程式碼驗證器。 如需詳細資訊,請參閱 https://tools.ietf.org/html/rfc7636

參數:

codeVerifier

extraHttpHeaders

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

為令牌請求新增額外標頭

參數:

extraHttpHeaders

extraQueryParameters


public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

已被取代

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

為令牌請求新增查詢參數

參數:

extraQueryParameters

redirectUri

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder redirectUri(URI redirectUri)

重定向 Azure 入口網站註冊的 URI,該 URI 用於 OAuth2.0 授權碼流程的第一步。 如需詳細資訊,請參閱 https://aka.ms/msal4j-authorization-code-flow

不可為空值。

參數:

redirectUri

scopes

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder scopes(Set<String> scopes)

應用程式請求存取權限的範圍

參數:

scopes

tenant

public AuthorizationCodeParameters.AuthorizationCodeParametersBuilder tenant(String tenant)

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

參數:

tenant

toString

public String toString()

覆寫:

AuthorizationCodeParameters.AuthorizationCodeParametersBuilder.toString()

適用於