通过Postman使用Umbrella报告API

简介

本文档介绍如何在Postman中使用Cisco Umbrella Reporting API。

先决条件

要求

本文档没有任何特定的要求。

使用的组件

本文档中的信息基于Cisco Umbrella。

本文档中的信息都是基于特定实验室环境中的设备编写的。本文档中使用的所有设备最初均采用原始（默认）配置。如果您的网络处于活动状态，请确保您了解所有命令的潜在影响。

概述

Umbrella API于2022年9月发布，提供用户友好且安全的平台，使用户能够构建、扩展和集成Umbrella。

Umbrella API终端托管在api.umbrella.com上，每个使用案例都有分组路径。API密钥既可以在Umbrella控制面板中的Admin > API keys下管理，也可以使用KeyAdmin API以编程方式管理。每个密钥可以精细配置，在五个主要使用案例下分组多个范围：

• 管理API终端使您能够调配和管理Umbrella API密钥和用户，查看角色，以及管理提供商和托管提供商的客户。
• 通过身份验证API终端，您可以授权其他服务与Umbrella平台的集成。
• 部署API终端使您能够调配、监控和管理网络和其他各种实体，并通过在现有Umbrella策略中配置它们来保护这些实体的安全。
• 策略API终端使您能够调配和管理目标列表以及每个列表的目标。
• 报告API终端使您能够读取和审核有关部署的实时安全信息。Umbrella应用发现API可让您深入了解基于云的应用。

本文介绍如何通过API收集活动搜索报告。

总括程序

1.从Umbrella控制面板导航到Admin > API Keys。

2.选择API Keys > Add。

3.在密钥范围下，选择报告，然后选择创建密钥。

21495050167956

管理员可以根据每个API密钥的预期用途调整每个范围在读/写和只读之间的访问级别，而API密钥可以配置为在预定义日期过期。您需要在此步骤收集API密钥/密钥，因为它们当前可见，之后无法显示。 

API凭证生成API访问令牌，有效期为60分钟。此过程支持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标志，才能重定向curl HTTP请求并保留授权报头。

21608126036628

POSTMAN:在Postman环境中，导航到API并选择GET方法。导航到设置>启用跟随授权信头，为重定向请求保留授权信头。

21608126042388

响应

向URL发送GET操作后，您可以收到各种状态代码：

• 状态：200:请求已成功获取您请求的信息。
• 状态：400：请求无效。它可能与您发送查询的URL相关。一个或多个参数不正确。
• 状态：401:未授权。授权标头缺失或令牌未授权。
• 状态：403：已禁止。令牌无效。