AuthorizationRequestUrlParameters.Builder 類別

  • java.lang.Object
    • com.microsoft.aad.msal4j.AuthorizationRequestUrlParameters.Builder

public static class AuthorizationRequestUrlParameters.Builder

建構函式摘要

建構函式 Description
Builder()

方法摘要

修飾詞與類型 方法與描述
AuthorizationRequestUrlParameters build()
Builder claims(ClaimsRequest val)

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

Builder claimsChallenge(String val)

在 Azure AD 租戶管理員啟用條件存取政策且政策未被達成的情況下,MsalServiceException會包含需要同意的索賠。

Builder codeChallenge(String val)

用於透過 Proof of Key for Code Exchange(PKCE)來確保授權碼授予。

Builder codeChallengeMethod(String val)

用於編碼程式碼驗證器以編碼程式碼挑戰參數的方法。

Builder correlationId(String val)

用於關聯遙測請求的識別碼。

Builder domainHint(String val)

提供使用者應該使用租戶或網域登入的提示。

Builder extraQueryParameters(Map<String,String> val)

除了已提供的參數清單外,還可以加入請求的查詢參數。

Builder extraScopesToConsent(Set<String> val)

你可以事先請求最終使用者同意的範圍,以及應用程式請求存取的範圍。

Builder instanceAware(boolean val)

若設為 true,授權結果將包含使用者家用雲的權限,且此權限將用於令牌請求,而非應用程式中設定的權限。

Builder loginHint(String val)

如果你事先知道使用者名稱或電子郵件地址,可以用來預先填入登入頁面的使用者名稱/電子郵件欄位。

Builder nonce(String val)

要求中包含的值,也會在權杖回應中返回。

Builder prompt(Prompt val)

表示必要的使用者互動類型。

Builder redirectUri(String val)

重定向 URI,讓你的應用程式能接收認證回應。

Builder responseMode(ResponseMode val)

指定應該用什麼方法將驗證結果傳送到你的應用程式。

Builder scopes(Set<String> val)

應用程式請求存取權限且使用者同意的範圍。

Builder state(String val)

要求中包含的值,也會在權杖回應中返回。

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

建構函式詳細資料

Builder

public Builder()

方法詳細資料

build

public AuthorizationRequestUrlParameters build()

claims

public AuthorizationRequestUrlParameters.Builder claims(ClaimsRequest val)

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

參數:

val

claimsChallenge

public AuthorizationRequestUrlParameters.Builder claimsChallenge(String val)

在 Azure AD 租戶管理員啟用條件存取政策且政策未被達成的情況下,MsalServiceException會包含需要同意的索賠。

參數:

val

codeChallenge

public AuthorizationRequestUrlParameters.Builder codeChallenge(String val)

用於透過 Proof of Key for Code Exchange(PKCE)來確保授權碼授予。 若包含 codeChallenge,則必須如此。 欲了解更多資訊,請參閱PKCE區域資源基金: https://tools.ietf.org/html/rfc7636

參數:

val

codeChallengeMethod

public AuthorizationRequestUrlParameters.Builder codeChallengeMethod(String val)

用於編碼程式碼驗證器以編碼程式碼挑戰參數的方法。 可以是普通或S256。 若排除,則假設程式碼挑戰為明文。 欲了解更多資訊,請參閱PKCE區域資源基金: https://tools.ietf.org/html/rfc7636

參數:

val

correlationId

public AuthorizationRequestUrlParameters.Builder correlationId(String val)

用於關聯遙測請求的識別碼。 通常是 GUID。

參數:

val

domainHint

public AuthorizationRequestUrlParameters.Builder domainHint(String val)

提供使用者應該使用租戶或網域登入的提示。 網域提示的價值是租戶註冊的網域。

參數:

val

extraQueryParameters

public AuthorizationRequestUrlParameters.Builder extraQueryParameters(Map<String,String> val)

除了已提供的參數清單外,還可以加入請求的查詢參數。

參數:

val

extraScopesToConsent

public AuthorizationRequestUrlParameters.Builder extraScopesToConsent(Set<String> val)

你可以事先請求最終使用者同意的範圍,以及應用程式請求存取的範圍。

參數:

val

instanceAware

public AuthorizationRequestUrlParameters.Builder instanceAware(boolean val)

若設為 true,授權結果將包含使用者家用雲的權限,且此權限將用於令牌請求,而非應用程式中設定的權限。

參數:

val

loginHint

public AuthorizationRequestUrlParameters.Builder loginHint(String val)

如果你事先知道使用者名稱或電子郵件地址,可以用來預先填入登入頁面的使用者名稱/電子郵件欄位。 應用程式通常在重新認證時會使用此參數,因為他們已經從先前登入時用preferred_username聲明擷取了使用者名稱。

參數:

val

nonce

public AuthorizationRequestUrlParameters.Builder nonce(String val)

要求中包含的值,也會在權杖回應中返回。 通常使用隨機產生的唯一值來防止跨站請求偽造攻擊。

參數:

val

prompt

public AuthorizationRequestUrlParameters.Builder prompt(Prompt val)

表示必要的使用者互動類型。 可能的值有 Prompt

參數:

val

redirectUri

public AuthorizationRequestUrlParameters.Builder redirectUri(String val)

重定向 URI,讓你的應用程式能接收認證回應。 它必須與 Azure 入口網站中登記的其中一個重定向 URI 完全吻合。

參數:

val

responseMode

public AuthorizationRequestUrlParameters.Builder responseMode(ResponseMode val)

指定應該用什麼方法將驗證結果傳送到你的應用程式。

參數:

val

scopes

public AuthorizationRequestUrlParameters.Builder scopes(Set<String> val)

應用程式請求存取權限且使用者同意的範圍。

參數:

val

state

public AuthorizationRequestUrlParameters.Builder state(String val)

要求中包含的值,也會在權杖回應中返回。 通常使用隨機產生的唯一值來防止跨站請求偽造攻擊。 該狀態也用於編碼使用者在驗證請求發生前的狀態資訊。

參數:

val

適用於