Code42 API发布说明- Code42支持

概述

本文列出了Code42 api的发布说明。单击下面的月份以展开或折叠详细信息。

根据我们的标准做法，本文中描述的已弃用项目将在宣布之日起一年内过时，并在弃用一年后终止支持。如果您的Code42 API脚本使用了已弃用的项目，在生命结束日期之前更新脚本。如果不更新脚本，Code42不能保证已弃用的api将按预期工作。如果你需要帮助，请联系我们的技术支持工程师．

Code42开发者门户
看到Code42开发者门户获取更多API文档和资源。门户提供:

Incydr方法文档的单一访问点，包括Code42的方法REST API， Python SDKpy42,命令行界面
单个请求URL对于每个云实例的Code42 API调用
API参考文档

尽可能多地使用Code42开发者门户来满足您的API需求。门户中的api是Incydr用户与Code42集成的首选方式。如果您使用的Code42 api没有出现在Code42开发者门户上，联系我们的技术支持工程师以获得与Code42集成的最佳方式的指导。

2022年10月

增强和更新

2022年10月26日

中增加了以下合法持有apiCode42开发者门户．在路径示例中，使用replace< matterId >与合法持有事项的ID:
- 创建策略：POST / v1 / legal-hold /政策
- 将用户从事项中移除：POST / v1 / legal-hold /重要/ < matterId > /托管人/删除

2022年10月6日

增加了对Code42命令行界面中的API客户端．在CLI下使用API客户端，创建一个API客户端并使用其客户端ID和秘密进行身份验证。
添加了一个集成指南部分到包含集成指南的Code42开发人员门户微软的哨兵使用py42或Code42命令行界面(CLI)。有关其他集成的信息，请参见Code42集成资源．
的新版本(v2)规则api并弃用了以前的版本(v1)。有关以下v2规则api的完整文档，请参见Code42开发者门户：
- GET / v2 / alert-rules / < ID >
- 获得/ v2 / alert-rules
- POST / v2 / alert-rules / < ID > /启用
- POST / v2 / alert-rules /启用
- POST / v2 / alert-rules / < ID > /禁用
- POST / v2 / alert-rules /禁用
- 删除/ v2 / alert-rules / < ID > /用户
- GET / v2 / alert-rules / ID > < /用户

的用法

v1规则接口

2022年10月6日

以下内容的上一版本(v1)规则api在Code42开发人员门户中已弃用，并被新版本(v2)所取代。

弃用api	新的api
`POST / v1 / alert-rules / update-is-enabled` （v1 -启用或禁用规则列表）	`POST / v2 / alert-rules /启用` （v2 -启用一组规则） `POST / v2 / alert-rules /禁用` （v2 -禁用一组规则） `POST / v2 / alert-rules / < ID > /启用` （2 -通过id启用单个规则） `POST / v2 / alert-rules / < ID > /禁用` （v2 -根据id禁用单个规则）
`POST / v1 / alert-rules /添加用户` （v1 -将用户添加到规则的监视列表中）	NA
`POST / v1 / alert-rules /删除用户` （v1 -从规则的监视列表中删除用户）	NA
`POST / v1 / alert-rules / remove-user-aliases` （v1 -从规则的监视列表中删除用户别名）	NA
`POST / v1 / alert-rules /之后,所有用户` （v1 -从规则的监视列表中删除所有用户）	`删除/ v2 / alert-rules / < ID > /用户` （v2 -从规则的用户名过滤器中删除所有用户）
`POST / v1 / alert-rules /查询用户` （v1 -获取分配给给定规则的用户）	`GET / v2 / alert-rules / ID > < /用户` （v2 -获取规则的用户名筛选器） `GET / v2 / alert-rules / < ID >` （v2—获取单个规则的详细信息）
`POST / v1 / alert-rules / query-cloud-share-permissions-rule` （v1 -获取一组云共享权限规则的详细信息）	`获得/ v2 / alert-rules` （v2 -获取服务中的所有规则）
`POST / v1 / alert-rules / query-endpoint-exfiltration-rule` （v1 -获取一组端点过滤规则的详细信息）	`获得/ v2 / alert-rules` （v2 -获取服务中的所有规则）
`POST / v1 / alert-rules / query-file-type-mismatch-rule` （v1 -获取文件类型不匹配规则集的详细信息）	`获得/ v2 / alert-rules` （v2 -获取服务中的所有规则）
`POST / v1 / alert-rules / query-file-name-rule` （v1 -获取一组“文件名”规则的详细信息）	`获得/ v2 / alert-rules` （v2 -获取服务中的所有规则）

用于查询规则的警报API

2022年10月6日

的POST / v1 /警告/ / query-rule-metadata规则API (告警应用中所有规则的查询列表)已弃用，并由获得/ v2 / alert-rulesAPI (v2 -获取服务中的所有规则）.

2022年9月

增强和更新

2022年9月9日

增加了对py42中的API客户端．要使用py42的API客户端，创建一个API客户端并使用它的客户端ID和秘密来启动SDKClient。

2022年9月7日

中添加了以下Users apiCode42开发者门户．在路径示例中，使用replace<标识>使用用户的唯一ID:
- 获取与用户关联的角色:GET / v1 /用户/ < userId > /角色
- 更新与用户关联的角色:把/ v1 /用户/ < userId > /角色
- 激活用户:POST / v1 /用户/ < userId > /激活
- 停用用户:POST / v1 /用户/ < userId > /禁用
- 移动用户到指定组织:POST / v1 /用户/ < userId > /移动

的用法

已弃用的不支持分页的合法保留api

2022年9月22日

已弃用的不支持分页的合法保留api，并将其替换为支持分页并包含totalSize在回应中。以下是已弃用的Legal Hold api，以及在脚本中使用的相应的新api。

弃用api 被api替换
在Code42开发者门户

GET / api / v31 / legal-hold-policy /列表

GET / v1 / legal-hold /政策

（获取一份政策清单）

GET / api / v31 / legal-hold-matter /列表

GET / v1 / legal-hold /问题

（列出事情的清单）

GET / api / v31 / legal-hold-membership /列表

GET / v1 / legal-hold /重要/ < matterId > /保管人

（获取一份物质管理人的名单）

支持结束

2022年9月23日

删除了/ api / AuthToken /用于云存储的API。由于此API仅在有限的云存储场景中调用，因此仅在使用时才会受到影响py42版本1.25.1或更早版本自动恢复文件。将py42实例升级为版本1.26或更高版本。

2022年8月

增强和更新

2022年8月1日

的案例API中添加了以下案例APICode42开发者门户．以路径为例，使用replace< caseNumber >与案件的唯一ID:
- 导出案例的部分或全部组件：GET / v1 /案例/ < caseNumber > /出口/满的

支持结束

2022年8月31日

删除了对v3_user_token计划最初在2022年1月弃用．的v3_user_token方案将被持票人方案，这是不记名代币的标准方案。

使用这个头来传递令牌:
授权:承载<令牌>

2022年7月

增强和更新

2022年7月21日

将以下组织api添加到Code42开发者门户．在路径示例中，使用replace< orgGuid >该组织的全球唯一ID:
- 获得一个组织的列表：GET / v1 /组织
- 创建一个组织：POST / v1 /组织
- 找一个特定的组织：GET / v1 /组织/ < orgGuid >
- 更新一个特定的组织：把/ v1 /组织/ < orgGuid >
- 激活一个特定的组织：POST / v1 /组织/ < orgGuid > /激活
- 禁用一个特定的组织：POST / v1 /组织/ < orgGuid > /禁用

2022年7月18日

在Code42开发者门户中添加了以下api，以支持构建与观察名单中：
- 部门
  - 获得一个部门列表：GET / v1 /部门
- 目录组织
  - 获取目录组列表：GET / v1 / directory-groups

2022年6月

增强和更新

2022年6月21日

的v2 / file-eventsAPI添加了新的字段(参见v2 -搜索文件事件在Code42开发者门户网站):
- event.inserted:表示接收事件以供Code42索引的日期和时间。这可能与现有的略有不同@timestamp字段，该字段指示最初观察到事件的日期和时间。
- destination.domains中报告的url的域部分destination.tabs.url．
- source.domains中报告的url的域部分source.tabs.url．(注:虽然名称相似，但此字段与source.domain，报告用户设备的FQDN或IP地址。)

2022年5月

增强和更新

2022年5月20日

增加了文件事件api的新版本(v2)，并弃用了以前的版本(v1)。api的数据模型通过响应中数据模型元素的新分组得到了改进。有关以下v2文件事件api的完整文档，请参见Code42开发者门户：
- / v2 / file-events
- / v2 / file-events /出口
- / v2 / file-events /分组

2022年5月19日

增加了对Code42命令行接口中的监视列表．

2022年5月18日

删除了email_promo参数。用户端点，因为它不再使用。

2022年5月12日

增加了对py42中的监视列表．

的用法

2022年5月20日

以下内容的上一版本(v1)文件事件api在Code42开发人员门户中已弃用，并被新版本(v2)所取代。
- / v1 / file-events
- / v1 / file-events /出口
- / v1 / file-events /分组

2022年5月18日

弃用的用户api

以下是已弃用的User api，以及在脚本中使用的相应的新api。有关其他用户api，请参见Code42开发者门户中的用户api．

弃用API	被api替换在Code42开发者门户
`把/ api / UserBlock / < user_id >`	NA
`删除/ api / UserBlock / < user_id >`	NA
`把/ api / UserDeactivation / < user_id >`	`POST / v1 /用户/ < userId > /禁用` （停用用户）
`删除/ api / UserDeactivation / < user_id >`	`POST / v1 /用户/ < userId > /激活` （激活用户）
`POST / api / UserRole`	`把/ v1 /用户/ < userId > /角色` （更新与用户关联的角色）
`删除/ api / UserRole吗?用户id = < user_id > &roleId = < role_id >`	NA
`GET / api / UserRole / < userId >`	`GET / v1 /用户/ < userId > /角色` （获取与用户关联的角色）
`POST / api / UserMoveProcess`	`POST / v1 /用户/ < userId > /移动` （移动用户到指定组织）

注意:在路径示例中，请使用replace<标识>使用用户的唯一ID。

已弃用的Org api

以下是已弃用的Org api，以及在脚本中使用的相应的新api。有关其他Org api，请参见Code42开发者门户中的组织api．

注意:在路径示例中，请使用replace< orgGuid >使用该组织的唯一ID。

弃用api	方法中的api替换Code42开发者门户
`/ api / v1 / Org`	`GET / v1 /组织` （获得一个组织的列表）
`POST / api / v1 / Org`	`POST / v1 /组织` （创建一个组织）
`把/ api / v1 / Org`	`把/ v1 /组织/ < orgGuid >` （更新一个特定的组织）
`把/ api / v1 / OrgBlock`	NA
`删除/ api / v1 / OrgBlock`	NA
`把/ api / v1 / OrgDeactivation`	`POST / v1 /组织/ < orgGuid > /激活` （激活一个特定的组织）
`删除/ api / v1 / OrgDeactivation`	`POST / v1 /组织/ < orgGuid > /禁用` （禁用一个特定的组织）

2022年2月

增强和更新

2022年2月28日

添加观察名单中api在Code42开发者门户中，以支持与观察名单中．

2022年2月17日

删除了lastLoginDate参数。用户资源。

的用法

2022年2月28日

弃用检测列表在Code42开发者门户网站。将检测列表api替换为观察名单中api．

2022年1月

增强和更新

2022年1月26日

的www-authenticate头从Code42 API中移除。因此，在web浏览器中不再支持使用基本身份验证进行API调用(例如下载CSV文件)。要进行API调用，请使用编程或类似于Postman或cURL的工具。同样由于此更改，PowerShell不再支持Code42 api的基本身份验证，除非您为身份验证设置了请求标头。

的用法

基本身份验证

2022年1月26日

不支持基本身份验证Code42开发者门户中的api并且被替换为API的客户．Code42开发者门户之外的api将继续支持基本身份验证。进行此更改是为了与最少权限集成的安全最佳实践保持一致。betway365

以下是现在已弃用的基本身份验证API调用示例:

基本身份验证:

curl -u "<用户名>:<密码>" <请求url >/<资源> . curl -u

获取认证令牌的基本认证:

curl -X GET -u ":" /v1/auth . curl -X GET -u ":

这还包括在需要第二个因子(TOTP)令牌时使用基本身份验证来获取身份验证令牌。例如:

curl -X -H " top -auth: :" /v1/auth . sh

在路径示例中，使用replace< RequestURL >使用Code42云的URL路径。有关更多信息，请参见Code42 API身份验证方法．

不一致的API URL路径

2022年1月26日

Code42正在弃用不一致的Code42 API URL路径，并在所有API中使用统一的URL路径取代它们。此更改仅影响在脚本中使用旧的Code42 API路径的Code42客户。类中的调用不会影响此更改Code42开发者门户．

以下是已弃用的路径，以及在脚本中使用的相应新路径。

废弃的URL路径	新的URL路径
`< RequestURL >/<资源>`	`< RequestURL >/ api / v1 /<资源>`
`< RequestURL >/ api /<资源>`	`< RequestURL >/ api / v1 /<资源>`
`< RequestURL >/ <应用> / api /<资源>`	`< RequestURL >/ api / v1 /<资源>`
`< RequestURL >/ <应用> / api / v1 /<资源>`	`< RequestURL >/ api / v1 /<资源>`
`< RequestURL >/ <应用> / api / v2 /<资源>`	`< RequestURL >/ api / v2 /<资源>`
`< RequestURL >/ c42api / v3 /<资源>`	`< RequestURL >/ api / v3 /<资源>`

注意事项:

在路径示例中，使用replace< RequestURL >使用Code42云的URL路径。例如:
- 美国
  - US1:https://console.us.code42.com
  - 2:https://console.us2.code42.com
  - 之三:https://console.gov.code42.com（Code42联邦环境只有）
- 爱尔兰
  - EU1:https://console.ie.code42.com
那些v1和v2资源的初始字符是小写的实例，现在必须以大写字符开始。v3和更高api中的资源资本化没有变化。
在例子中，<应用>是下列之一:账户，应用程序，业务，客户管理，控制台，消费者，企业，enterprise-store，legal-hold，登录，合作伙伴，报告，搜索，betway365,或订阅．

v3_user_token方案

2022年1月26日

的v3_user_token方案已弃用，并由持票人方案，这是不记名代币的标准方案。

下面是已弃用的头文件，用于将用户令牌传递给API:
授权:v3_user_token

接下来，使用这个头文件来传递令牌:
授权:承载<令牌>

Auth/jwt API端点

2022年1月26日

的/ c42api / v3 /认证/ jwtendpoint现在已弃用为获取OAuth令牌的方法，取而代之的是API的客户．

不支持API客户端的API

2022年1月26日

以下api已弃用，因为它们不支持API的客户．

中的API执行所有API集成Code42开发者门户，以下API弃用不会影响您，因为Code42开发者门户中的API支持API客户端。

弃用的合法持有api

以下是已弃用的Legal Hold api，以及在脚本中使用的相应的新api。

弃用api	被api替换在Code42开发者门户
`GET / api / v4 / legal-hold-policy`	`GET / v1 / legal-hold /政策` （获取一份政策清单）
`POST / api / LegalHoldResource`	`POST / v1 / legal-hold /很重要` （创建一个事项）
`获得/ api / LegalHoldResource`	`GET / v1 / legal-hold /问题` （列出事情的清单）
`获得/ api / LegalHoldResource`	NA
`GET / api / LegalHoldSummary / < legalHoldUid >`	`GET / v1 / legal-hold /重要/ < matterId >` （做一件事）
`GET / api / LegalholdSummary吗?activeState = <活跃不活跃\| \|所有>`	`GET / v1 / legal-hold /问题` （列出事情的清单）
`GET / api / LegalHoldEventResource吗?legalHoldUid = < legalHoldUid >`	NA
`获得/ api / LegalHoldEventResource`	NA
`POST / api / LegalHoldMembershipResource`	`POST / v1 / legal-hold /重要/ < matterId > /保管人` （向事项中添加用户）
`GET / api / LegalHoldMembershipResource吗?userUid = < userUid >`	`GET / v1 / legal-hold托管人/ < userId >` （为用户获取事项列表）
`GET / api / LegalHoldMembershipResource吗?legalHoldUid = < legalHoldUid >`	`GET / v1 / legal-hold /重要/ < matterId > /保管人` （获取一份物质管理人的名单）
`GET / api / LegalHoldMembershipResource / < legalHoldMembershipUid >`	NA
`POST / api / LegalHoldMembershipDeactivation`	NA

以前的版本说明

在2022年1月之前，API发布说明被合并到我们的一般发布说明中。看到以前版本发布说明．

概述

2022年10月

增强和更新

的用法

v1规则接口

用于查询规则的警报API

2022年9月

增强和更新

的用法

已弃用的不支持分页的合法保留api

支持结束

2022年8月

增强和更新

支持结束

2022年7月

增强和更新

2022年6月

增强和更新

2022年5月

增强和更新

的用法

弃用的用户api

已弃用的Org api

2022年2月

增强和更新

的用法

2022年1月

增强和更新

的用法

基本身份验证

不一致的API URL路径

v3_user_token方案

Auth/jwt API端点

不支持API客户端的API

弃用的合法持有api

以前的版本说明

相关的话题