在事件转发中配置密钥

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

当前支持三种密钥类型:

密钥类型 描述
令牌 一个字符串,表示两个系统已知和理解的身份验证令牌值。
HTTP 包含用户名和密码的两个字符串属性。
OAuth2 包含多个属性以支持 OAuth2 验证规范。 系统会要求您提供所需信息,然后在指定的间隔内为您处理这些令牌的续订。 当前仅 客户端凭据 支持OAuth2版本。

本指南简要概述了如何为事件转发配置密钥(Edge)属性。

注意

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

先决条件

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

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

创建密钥

要创建密钥,请登录到数据收集UI,然后打开要在下添加密钥的事件转发属性。 接下来,选择 秘密 在左侧导航中,然后是 创建新密钥.

创建新密钥

下一个屏幕允许您配置密钥的详细信息。 为了让事件转发可用的密钥,必须将其分配到现有环境。 如果尚未为事件转发资产创建任何环境,请参阅 环境 ,以了解如何在继续之前配置它们。

注意

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

禁用环境

Target环境,请使用下拉菜单选择要将密钥分配到的环境。 在 密钥名称,在环境上下文中提供密钥的名称。 该名称在事件转发属性下的所有密钥中必须唯一。

环境和名称

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

添加环境

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

添加环境不可用

在此处,创建密钥的步骤因您创建的密钥类型而异。 有关详细信息,请参阅以下子部分:

令牌

要创建令牌密钥,请选择 令牌类型 下拉列表。 在 令牌 字段,请提供由您对其进行身份验证的系统所识别的凭据字符串。 选择 创建密钥 来保存秘密。

令牌密钥

HTTP

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

注意

保存凭据后,将使用 “基本”HTTP身份验证方案.

HTTP密钥

OAuth2

要创建OAuth2密钥,请选择 OAuth2类型 下拉列表。 在下面显示的字段中,提供 客户端ID 和 客户端密钥,以及 授权URL 的OAuth集成。 的 授权URL 数据收集UI中的字段是授权服务器主机和令牌路径之间的串联。

OAuth2密钥

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

凭据选项

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

刷新偏移

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

重要

OAuth密钥在刷新之间至少需要4小时,并且至少8小时内有效。 此限制允许您在生成的令牌出现问题时至少4小时进行干预。

例如,如果将“偏移”设置为 28800 (八小时),且访问令牌具有 expires_in of 36000 (10小时),因差异小于4小时而导致交换失败。

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

保存OAuth2偏移

编辑密钥

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

选择要编辑的密钥

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

编辑密钥

注意

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

重试密码交换

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

密钥类型 重试协议
令牌 选择 交换密钥 重试密钥交换。 此控件仅在有附加到该密钥的环境时可用。
HTTP 如果没有附加到该密钥的环境,请选择 交换密钥 将凭据交换到base64。 如果附加了环境,请选择“选择” 交换和部署密钥 交换基地64并部署秘密。
OAuth2 选择 生成令牌 用于交换凭据并返回来自身份验证提供程序的访问令牌。

删除密钥

删除 秘密 工作区中,选中其名称旁边的复选框,然后再选择 删除.

删除密钥

在事件转发中使用密钥

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

创建数据元素时,选择 核心 扩展,然后选择 密码 (对于数据元素类型)。 右侧面板会更新并提供下拉控件,用于向数据元素分配最多三个密钥:一个 开发, 暂存和 生产 分别进行。

数据元素

注意

只有与开发、暂存和生产环境相关的密钥才会显示其各自的下拉菜单。

通过为单个数据元素分配多个密钥并将其包含在规则中,可以使数据元素的值根据容器库在 发布流程.

具有多个密钥的数据元素

注意

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

后续步骤

本指南介绍了如何在数据收集UI中管理密钥。 有关如何使用Reactor API与密钥交互的信息,请参阅 secrets endpoint指南.

在此页面上