AuthorizationUrlRequest type

使用者傳遞的請求物件用來從伺服器取回代碼(授權碼授權流程的第一段)

  • 範圍(scopes)-應用程式請求存取權限的範圍陣列。
  • claims - 一個被要求的嚴格索賠請求,會被加入所有 /authorize 和 /token 呼叫中
  • authority - 應用程式取得代幣的權威的網址。
  • correlationId - 每個請求唯一的 GUID 設定,用於遠端追蹤請求以進行遙測。
  • redirectUri - 可由您的應用程式接收認證回應的重定向 URI。 它必須與 Azure 入口網站中登記的其中一個重定向 URI 完全吻合。
  • extraScopesToConsent - 當使用者事先需要同意時,為不同資源設定範圍。
  • responseMode - 指定傳送驗證結果到應用程式的方法。 可以是查詢、form_post或片段。 如果沒有傳遞任何值,則預設為查詢。
  • codeChallenge - 用於透過 Code Exchange 的 Proof of Key (PKCE) 確保授權碼授予。 欲了解更多資訊,請參閱PKCE區域資源基金:https://tools.ietf.org/html/rfc7636
  • codeChallengeMethod - 用於編碼程式碼驗證器以編碼 code challenge 參數的方法。 可以是「普通」或「S256」。 若排除,則假設程式碼挑戰為明文。 欲了解更多資訊,請參閱PKCE區域資源基金: https://tools.ietf.org/html/rfc7636
  • state - 請求中包含的值,且同時在標記回應中回傳。 通常使用隨機產生的唯一值來防止跨站請求偽造攻擊。 該狀態也用於編碼使用者在驗證請求發生前的狀態資訊。
  • 提示 - 表示所需的使用者互動類型。 登入:會強制使用者在該請求中輸入憑證,否定單點登入 none:確保使用者不會看到任何互動式提示。 若無法透過單點登入完成請求,端點會回傳interaction_required錯誤同意:使用者登入後會觸發 OAuth 同意對話框,要求使用者授權應用程式嗎?select_account:會中斷單點登入=ON,提供帳號選擇體驗,列出會話中所有帳號或任何被記憶的帳號,或提供選擇使用不同帳號的選項,建立: 會引導使用者進入帳號建立體驗,而非登入體驗
  • 帳戶 - 從 getAccount API 取得的帳戶資訊。 若未同時提供 loginHint 和 sid 參數,則會在特定情境下用於產生login_hint。
  • loginHint - 如果你事先知道使用者名稱或電子郵件地址,可以用來預先填入登入頁面的使用者名稱/電子郵件欄位。 應用程式通常在重新認證時會使用此參數,因為他們已經從先前登入時用preferred_username聲明擷取了使用者名稱。
  • sid - 會話識別碼,會話的唯一識別碼。 作為身份證代幣的可選申請。
  • domainHint - 提供使用者應使用以登入的租戶或網域提示。 網域提示的價值是租戶註冊的網域。
  • extraQueryParameters - 將自訂查詢參數的字串映射到 /authorize 呼叫中
  • tokenQueryParameters - 將自訂查詢參數的字串對字串映射到 /token 呼叫中
  • nonce - 請求中包含的值,並以 id 標記回傳。 通常會使用隨機產生的唯一數值來減少重播攻擊。
type AuthorizationUrlRequest = Partial<
  Omit<
    CommonAuthorizationUrlRequest,
    | "scopes"
    | "redirectUri"
    | "resourceRequestMethod"
    | "resourceRequestUri"
    | "authenticationScheme"
    | "requestedClaimsHash"
    | "storeInCache"
  >
> & { redirectUri: string; scopes: string[] }