在事件转发中配置密钥

在事件转发中,密钥是表示另一个系统的身份验证凭据的资源,允许安全交换数据。 只能在事件转发属性中创建密钥。

当前支持以下密钥类型:

密码类型 描述
Google OAuth 2 包含多个属性以支持 OAuth 2.0 身份验证规范,用于 Google Ads API发布/订阅API. 系统会要求您提供所需信息,然后按照指定的时间间隔处理这些令牌的续订。
HTTP 包含用户名和密码的两个字符串属性。
OAuth 2 包含多个属性以支持 客户端凭据授予类型 对于 OAuth 2.0 身份验证规范。 系统会要求您提供所需信息,然后按照指定的时间间隔处理这些令牌的续订。
OAuth 2 JWT 包含多个属性以支持的JSON Web令牌(JWT)配置文件 OAuth 2.0授权 格兰茨。 系统会要求您提供所需信息,然后按照指定的时间间隔处理这些令牌的续订。
令牌 表示两个系统都已知和理解的身份验证令牌值的单个字符串。

本指南提供了有关如何为事件转发配置密码的高级概述(EdgeExperience Platform )属性。

注意

有关如何在Reactor API中管理机密的详细指导,包括机密结构的JSON示例,请参阅 secrets API指南.

先决条件

本指南假设您已经熟悉如何管理UI中标记和事件转发的资源,包括如何创建数据元素和事件转发规则。 请参阅指南,网址为 管理资源 如果您需要简介。

您还应该实际了解标记和事件转发的发布流,包括如何向库添加资源并将内部版本安装到您的网站以进行测试。 请参阅 发布概述 了解更多详细信息。

创建密码

要创建密码,请选择 事件转发 在左侧导航中,打开您要在下添加密码的事件转发属性。 接下来,选择 密钥 在左侧导航中,其后是 创建新密码.

创建新密码

下一个屏幕允许您配置密码的详细信息。 要使某个密钥可由事件转发使用,必须将此密钥分配给现有环境。如果您没有为事件转发资产创建任何环境,请参阅上的指南 环境 以获取有关如何在继续操作之前配置它们的指导。

注意

如果您仍要在将密码添加到环境之前创建和保存该密码,请禁用 将密码附加到环境 在填写其余信息之前进行切换。 请注意,如果要使用密钥,则以后必须将其分配给环境。

禁用环境

目标环境,使用下拉菜单选择要为其分配密钥的环境。 下 密码名称,在环境的上下文中提供密码的名称。 在事件转发属性下的所有密钥中,此名称必须是唯一的。

环境和名称

一个密钥一次只能分配给一个环境,但您可以根据需要跨不同环境为多个密钥分配相同的凭据。 选择 添加环境 以向列表中添加另一行。

添加环境

对于您添加的每个环境,必须为关联的密钥提供另一个唯一的名称。 如果您耗尽了所有可用环境, 添加环境 按钮将不可用。

添加环境不可用

在此,根据您创建的密码类型,创建密码的步骤会有所不同。 有关详细信息,请参阅下面的子部分:

令牌

要创建令牌密码,请选择 令牌类型 下拉菜单。 在 令牌 字段,提供您正在验证的系统可识别的凭据字符串。 选择 创建密钥 保存密码。

令牌密码

HTTP

要创建HTTP密码,请选择 简单HTTP类型 下拉菜单。 在下面显示的字段中,为凭据提供用户名和密码,然后再选择 创建密钥 保存密码。

注意

保存后,使用对凭据进行编码 “基本”HTTP身份验证方案.

HTTP密码

OAuth 2

要创建OAuth 2密码,请选择 OAuth 2类型 下拉菜单。 在下面显示的字段中,提供您的 客户端ID 和 客户端密码,以及您的 令牌URL 用于您的OAuth集成。 此 令牌URL UI中的字段是授权服务器主机和令牌路径之间的连接。

OAuth 2密码

凭据选项,您可以提供其他凭据选项,例如 scopeaudience 键值对的形式。 要添加更多键值对,请选择 添加另一个.

凭据选项

最后,您可以配置 刷新偏移 密码的值。 这表示系统将在令牌过期前执行自动刷新的秒数。 等效时间(以小时和分钟为单位)显示在字段的右侧,并在您键入时自动更新。

刷新偏移

例如,如果将刷新偏移设置为缺省值 14400 (4小时)并且访问令牌具有 expires_in86400 (24小时),系统将在20小时内自动刷新密码。

重要

OAuth密钥在两次刷新之间至少需要四个小时,并且必须至少八小时内有效。 此限制为您提供了至少四个小时时间,以便在生成的令牌出现问题时进行干预。

例如,如果偏移设置为 28800 (8小时)并且访问令牌具有 expires_in36000 (十小时),由于由此产生的差异不到4小时,交换将失败。

完成后,选择 创建密钥 保存密码。

保存OAuth 2偏移

OAuth 2 JWT

要创建OAuth 2 JWT密码,请选择 OAuth 2 JWT类型 下拉菜单。

此 创建密钥 选项卡,并在中高亮显示OAuth 2 JWT密码 类型 下拉菜单。

注意

唯一 算法 当前支持对JWT进行签名的是RS256。

在下面显示的字段中,提供您的 发行者, 主题, Audience, 自定义声明, TTL,然后选择 算法 从下拉菜单中查找。 接下来,输入 私钥Id,以及您的 令牌URL 用于您的OAuth集成。 此 令牌URL 字段不是必填字段。 如果提供了值,则使用访问令牌交换JWT。 秘密将根据 expires_in 响应和 刷新偏移 值。 如果未提供值,则推送到边缘的密钥是JWT。 JWT将根据 TTL 和 刷新偏移 值。

此 创建密钥 选项卡,其中选中的输入字段突出显示。

凭据选项,您可以提供其他凭据选项,例如 jwt_param 键值对的形式。 要添加更多键值对,请选择 添加另一个.

此 创建密钥 选项卡突出显示 凭据选项 字段。

最后,您可以配置 刷新偏移 密码的值。 这表示系统将在令牌过期前执行自动刷新的秒数。 等效时间(以小时和分钟为单位)显示在字段的右侧,并在您键入时自动更新。

此 创建密钥 选项卡突出显示 刷新偏移 字段。

例如,如果将刷新偏移设置为缺省值 1800 (30分钟)并且访问令牌具有 expires_in3600 (1小时),系统将在1小时内自动刷新密码。

重要

OAuth 2 JWT密钥在两次刷新之间至少需要30分钟,并且必须至少在一小时内有效。 此限制为您提供至少30分钟的时间,以便在生成的令牌出现问题时进行干预。

例如,如果偏移设置为 1800 (30分钟)并且访问令牌具有 expires_in2700 (45分钟),由于由此产生的差异不到30分钟,交换将失败。

完成后,选择 创建密钥 保存密码。

此 创建密钥 选项卡突出显示 创建密钥

Google OAuth 2

要创建Google OAuth 2密码,请选择 Google OAuth 2类型 下拉菜单。 下 范围​中,选择要使用此密钥授予访问权限的Google API。 当前支持以下产品:

完成后,选择 创建密钥.

Google OAuth 2密码

此时会出现一个弹出窗口,通知您需要通过Google手动授权密钥。 选择 创建并授权 以继续。

Google授权弹出框

此时将显示一个对话框,允许您输入Google帐户的凭据。 按照提示操作,授予事件转发访问选定范围内数据的权限。 授权过程完成后,将创建密钥。

重要

如果您的组织为Google Cloud应用程序设置了重新身份验证策略,则创建的密钥在身份验证过期后不会成功刷新(根据策略配置,在1到24小时之间)。

要解决此问题,请登录到Google Admin Console并导航到 App access control 页面,以便将事件转发应用程序(Adobe Real-Time CDP事件转发)标记为 Trusted. 请参阅Google文档,了解有关 为Google Cloud Services设置会话长度 了解更多信息。

编辑密码

为资产创建密码后,您可以在 密钥 工作区。 要编辑现有密钥的详细信息,请从列表中选择其名称。

选择要编辑的密码

下一个屏幕允许您更改密码的名称和凭据。

编辑密码

注意

如果密钥与现有环境相关联,则无法将该密钥重新分配给其他环境。 如果您希望在不同的环境中使用相同的凭据,则必须 创建新密码 而是。 从此屏幕重新分配环境的唯一方法是,如果事先未将密码分配给环境,或者删除了密码附加到的环境。

重试密钥交换

您可以从编辑屏幕重试或刷新密钥交换。 此过程因所编辑的密钥类型而异:

密码类型 重试协议
令牌 选择 Exchange密码 以重试密钥交换。 此控件仅在环境附加到密钥时可用。
HTTP 如果没有将环境附加到密钥,请选择 Exchange密码 将凭据交换给base64。 如果附加了环境,请选择“选择” Exchange和部署密钥 交换到base64并部署密钥。
OAuth 2 选择 生成令牌 以交换凭据并从身份验证提供程序返回访问令牌。

删除密码

删除中的现有密码 密钥 在选中之前,请选中其名称旁边的复选框 删除.

删除密码

在事件转发中使用密钥

为了在事件转发中使用密钥,您必须首先创建 数据元素 那个秘密本身。 保存数据元素后,您可以将其包含在事件转发中 规则 并将这些规则添加到 ,这可以部署到Adobe的服务器,作为 生成.

创建数据元素时,选择 核心 扩展,然后选择 密码 (数据元素类型)。 右侧面板将更新并提供下拉控件,以便最多为数据元素分配三个密钥:一个用于 开发, 暂存、和 生产 的量度。

数据元素

注意

只有附加到开发、暂存和生产环境的密码才会显示在各自的下拉列表中。

通过将多个密钥分配给单个数据元素并将其包含到一个规则中,您可以让数据元素的值根据包含库在 发布流.

具有多个密钥的数据元素

注意

创建数据元素时,必须分配开发环境。 暂存环境和生产环境的密钥不是必需的,但如果其密钥类型数据元素没有为相关环境选择密钥,则尝试迁移到这些环境的构建将失败。

后续步骤

本指南介绍了如何在UI中管理密钥。 有关如何使用Reactor API与机密交互的信息,请参阅 密钥端点指南.

在此页面上