目錄

簡介

必要條件

需求

採用元件

概觀

Umbrella過程

Postman程式

響應

簡介

本文檔介紹如何在Postman中使用Cisco Umbrella Reporting API。

必要條件

需求

本文件沒有特定需求。

採用元件

本檔案中的資訊是根據Cisco Umbrella。

本文中的資訊是根據特定實驗室環境內的裝置所建立。文中使用到的所有裝置皆從已清除（預設）的組態來啟動。如果您的網路運作中，請確保您瞭解任何指令可能造成的影響。

概觀

Umbrella API於2022年9月發佈，提供一個使用者友好且安全的平台，使使用者能夠在Umbrella的基礎上構建、擴展和整合。

Umbrella API終端託管在api.umbrella.com上，每個使用案例都有分組的路徑。可以在Umbrella控制面板中的Admin > API keys下管理API金鑰，也可以使用KeyAdmin API以程式設計方式管理API金鑰。每個金鑰可以細粒度配置，並在五個主要使用案例下分組多個範圍：

- 管理API終端使您能夠調配和管理Umbrella API金鑰和使用者、檢視角色以及管理提供商和託管提供商的客戶。

- Auth API端點可授權其他服務與Umbrella平台的整合。

- 部署API終端使您能夠調配、監控和管理網路和其他各種實體，並通過在現有Umbrella策略中配置它們來保護這些實體的安全。

- 策略API端點使您能夠調配和管理目標清單以及每個清單的目標。

- 報告API端點使您能夠讀取和稽核有關部署的即時安全資訊。Umbrella App Discovery API可讓您深入瞭解基於雲的應用程式。

本文演示如何通過API收集活動搜尋報告。

Umbrella過程

1.從Umbrella控制面板導航到Admin > API Keys。

2.選擇API Keys > Add。

3.在金鑰範圍下，選擇Reports，然後選擇Create Key。

21495050167956

管理員可以根據每個API金鑰的預期用途調整每個作用域的讀/寫和只讀訪問級別，而API金鑰可以配置為在預定義日期過期。在此步驟中，您需要收集API金鑰/金鑰，因為它們當前可見，之後無法顯示。

API憑證生成有效期為60分鐘的API訪問令牌。此過程支援OAuth 2.0客戶端憑證流。在Umbrella多組織或服務提供商環境中，父組織API憑證可用於為授權過程中指定的子組織生成具有相同範圍的訪問令牌。

Postman程式

首先，需要建立OAuth 2.0訪問令牌。Umbrella API身份驗證路徑以https://api.umbrella.com/auth/v2開頭。提交POST查詢和使用者API金鑰作為使用者名稱，API密碼作為密碼後，將生成訪問令牌。

21606708808468

21607051456276

在此步驟中，您需要收集存取權杖。現在，您可以使用訪問令牌檢索資訊。

您需要選擇GET方法，並輸入API路徑（包括所需的引數）和訪問令牌。在此示例中，您可以為過去7天的DNS流量從活動搜尋中專門檢索100個報告。

21607952074772

在另一個示例中，您可以嘗試從活動搜尋提取1000個報告，僅針對過去7天的DNS流量，特別是針對「gsa.apple.com」域。

21607927544468

您可以諮詢請求查詢引數，以發現您可以在API查詢中使用的其他引數。

附註：如果HTTP客戶端請求不是源自Umbrella資料倉儲所在的大洲，則Umbrella伺服器會使用302 Found進行響應。若要自動重定向HTTP請求並保留HTTP授權標頭，可以設定其他標誌或啟用重定向設定。

捲曲:您必須傳遞 — L或 — location和 — location-trusted標誌以重定向捲曲HTTP請求並保留授權標頭。

21608126036628

郵政:在Postman環境中，導航到一個API並選擇一個GET方法。導覽至Settings > Enable Follow Authorization header，以保留重新導向請求的授權標頭。

21608126042388

響應

向URL傳送GET操作後，您可以接收各種狀態代碼：

- 狀態:200:請求已成功獲取您請求的資訊。

- 狀態： 400：請求無效。它可能與您傳送查詢的URL相關。一個或多個引數不正確。

- 狀態：401：未授權。缺少授權標頭或令牌未經授權。

- 狀態：403：禁止。令牌無效。