目录

简介

Umbrella API概述

API终端和管理

API使用案例和终端组

API密钥访问和到期

身份验证和令牌生命周期

文档和资源

支持

简介

本文档介绍Umbrella API平台的功能、配置选项和可用资源。

Umbrella API概述

Umbrella API平台为构建、扩展和与Umbrella集成提供安全环境。使用API创建跨平台工作流程，将威胁情报与其他安全解决方案聚合起来，以扩展实施、提高可视性并自动进行事件响应。

API终端和管理

- 所有Umbrella API终端均托管在api.umbrella.com。

- 终端按使用案例分组,每个使用特定路径。

- 在Admin > API keys下的Umbrella控制面板中管理API密钥，或者使用KeyAdmin API以编程方式管理API密钥。

API使用案例和终端组

使用按以下主要使用案例分组的粒度范围配置每个API密钥：

- 管理API终端:调配和管理API密钥和用户，查看角色，以及管理提供商和托管提供商的客户。

- 身份验证API终端：授权Umbrella和其他服务之间的集成。

- 部署API终端:调配、监控和管理网络和实体，通过在现有Umbrella策略中配置网络和实体来保护它们。

- 策略API终端:调配和管理目标列表和每个列表的目标。

- 调查API终端:研究Umbrella解析器观察到的域、IP地址和URL。

- 报告API终端:读取和审核有关部署的实时安全信息。应用发现API提供对基于云的应用的见解。

API密钥访问和到期

- 根据目标用途，将每个范围的访问级别设置为“读/写”或“只读”。

- 根据需要将API密钥配置为在预定义的日期过期。

15143392160916

身份验证和令牌生命周期

- API凭证生成有效期为60分钟的访问令牌。

- 身份验证过程使用OAuth 2.0客户端凭证流。

- 在多组织或服务提供商环境中，父组织API凭证可以在授权期间为指定的子组织生成具有相同作用域的访问令牌。

文档和资源

- 访问综合说明和使用案例文档。

- 每个API使用案例均记录在API参考中。

- 所有端点和参数都列在OpenAPI规范中，并链接在每个使用案例概述的底部。

- 如果您使用传统Umbrella API，请查看API迁移指南。

- 使用Postman Collection for the Umbrella API进行初始测试。

- 在Cisco developer页面的Cloud Security（云安全）部分了解其他资源、学习实验和API测试沙盒。

支持

有关Umbrella API的问题或其他帮助，请联系Umbrella支持部门。