CommonDeviceCodeRequest type

套件:
@azure/msal-common

Oauth2 裝置程式碼流程的參數。

  • 範圍（scopes）-應用程式請求存取權限的範圍陣列。
  • 權限：- 權限機構的網址，即 MSAL 取得憑證的安全憑證服務（STS）。 如果 authority 是設定在用戶端應用程式物件上，這會覆蓋該值。 覆寫該數值每次都會進行權威驗證。 如果所有請求都使用相同的權限，請設定在應用程式物件上，而非請求本身。
  • correlationId - 每個請求唯一的 GUID 設定，用於遠端追蹤請求以進行遙測。
  • deviceCodeCallback - 包含裝置代碼回應的回調。 訊息應該會顯示給最終使用者。 最終使用者接著可以導航到verification_uri，輸入user_code並輸入憑證。
  • cancel - 布林值以取消裝置程式碼端點的輪詢。 當使用者在另一台裝置上進行認證時，MSAL 會輪詢安全令牌服務的憑證端點，時間間隔為裝置代碼回應中指定的間隔（通常為 15 分鐘）。 若要停止輪詢並取消請求，請設定 cancel=true。
  • resourceRequestMethod - 用於從資源請求資料的 HTTP 請求類型（例如「GET」、「POST」等）。 用於持有權證明流程。
  • resourceRequestUri - 該標記將用於的 URI。 用於持有權證明流程。
  • 逾時 - 使用者明確設定用於輪詢裝置碼端點的秒數逾時時間。 在此期間結束時;假設裝置代碼尚未過期;裝置代碼輪詢會被停止，請求也被取消。 裝置代碼過期視窗在此期間內始終優先。
  • extraQueryParameters - 新增自訂查詢參數的字串到字串映射
type CommonDeviceCodeRequest = Omit<
  BaseAuthRequest,
  "tokenQueryParameters" | "tokenBodyParameters"
> & {
  cancel?: boolean
  deviceCodeCallback: (response: DeviceCodeResponse) => void
  extraQueryParameters?: StringDict
  timeout?: number
}