创建和管理 HighBond 访问令牌

在管理 API 令牌页面中创建或管理个人 HighBond 访问令牌，可通过启动面板的“个人资料”页面访问该页面。

什么是访问令牌？

访问令牌是一个确定用户的字符串，可以验证到其它应用程序的访问。

您需要的访问令牌取决于您需要做什么：

Analytics 令牌

每次激活 Analytics 时都会自动生成 Analytics 令牌，并将其存储在注册表中。

  • 如果您使用的是 Analytics 14 或更低版本，并且您手动创建一个 ACLGRC 访问令牌，则该令牌被在启动面板中归类为 Analytics 令牌类型。
  • 如果您使用的是 Analytics 14.1，并且您手动创建一个 HighBond 访问令牌，则该令牌被在启动面板中归类为 Analytics 令牌类型。

工作原理

在启动面板中，管理 API 令牌页面会显示您已生成的所有访问令牌。

您可以使用管理 API 令牌页面执行以下操作：

  • 复制令牌
  • 提供一个标签，以描述或识别访问令牌
  • 锁定访问令牌，防止其被修改或删除
  • 删除访问令牌

注意

访问令牌提供了许多权限，因此保持其安全和私密很重要。避免在公共访问区域分享访问令牌。

权限

任何用户都可以创建 Analytics 令牌。要创建 HighBond API 令牌或者活动日志 API 令牌，您必须是至少一个 Diligent One 实例中的系统管理员。

所有用户都可以管理他们自己的访问令牌。

创建访问令牌

  1. 打开启动面板。

    2. 说明

    如果贵公司在 Diligent One 中使用多个实例，请确保相应的实例处于活动状态。

  2. 选择 个人资料菜单图标 > 个人资料。
  3. 在应用程序令牌旁边，单击管理。管理 API 令牌页面打开。
  4. 单击 +添加令牌并从下拉菜单中选择相应的选项（例如，HighBond API、Analytics 或活动日志 API）。此时会显示新建令牌侧面板。
  5. 填写侧面板中的各个字段以创建令牌。

    说明

    所有字段都是创建令牌的必填字段，包括描述字段。唯一的例外情况是，您选择不添加令牌到期日期。在这种情况下，无需填写距离令牌到期的天数，因为此项默认为永不过期。

    1. 输入描述。

      提示

      请在描述中添加拟使用此令牌的所有情景及用途。这样做的原因是当令牌过期时需要及时更换，添加详细的描述可以在需要更换令牌时节约时间和精力。

    2. 可选。启用或禁用令牌到期。

      说明

      默认情况下，应该启用（打开）设置令牌到期日期的功能。如果禁用该功能，则令牌将永不过期。

    3. 输入距离令牌到期的天数，自令牌创建之日起最长为一年（365 天）。
    4. 请输入 Diligent One 账户密码进行身份验证。
  6. 单击生成令牌。侧面板会刷新，并显示一则“已成功生成令牌”的确认消息，同时包含令牌 ID、到期日期（令牌到期的日期和时间），以及描述。
  7. 单击复制。此时会显示已复制到剪贴板消息，确认已成功复制令牌。

    注意

    请在关闭侧面板之前，务必保存令牌。作为一项安全措施，这是您访问令牌的唯一机会。如果您没有保存且忘记了令牌，则需要创建一个新令牌。
  8. 单击关闭。新建令牌侧面板会关闭。
  9. 将令牌粘贴到应用程序或脚本中。

    说明

    请将令牌视为密码，并且不要与他人共享。

管理 API 令牌

可从管理 API 令牌页面查看现有令牌的列表、编辑令牌描述、锁定令牌使其无法被编辑或删除，以及删除令牌。

  1. 打开启动面板。

    2. 说明

    如果贵公司在 Diligent One 中使用多个实例，请确保相应的实例处于活动状态。

  2. 选择 个人资料菜单图标 > 个人资料。
  3. 在应用程序令牌旁边，单击管理。管理 API 令牌页面打开。
  4. 请完成以下任一操作。

审核访问令牌

要找到令牌，可以通过搜索、排序和过滤来查找特定令牌。请执行以下任一操作：

  • 搜索令牌：在搜索栏中，输入访问令牌的前几个字符（最多七个字符）。这将会返回范围缩小的结果列表。
  • 排序令牌：单击任意列标题，按升序或降序对所选的列进行排序。
  • 过滤令牌：默认情况下，会显示生成的所有令牌。但是，您可以将令牌列表过滤为一个子集，例如令牌是否已锁定，或按令牌类型过滤：Analytics、活动日志或 HighBond API。从可用的下拉菜单中选择所需的过滤器，以过滤令牌列表。单击清除，可移除已应用的所有过滤器。

编辑访问令牌描述

  1. 单击铅笔图标 。描述字段变为可内联编辑的字段。
  2. 更新描述并单击复选标记 以保存更改。更新后的描述会显示在表中。

锁定或解锁访问令牌

如果想要阻止令牌遭到删除以及令牌描述遭到编辑，则可以将其锁定。也可以解锁令牌，以更改描述和启用删除。

  • 单击令牌旁边打开的锁 ，可禁用删除令牌和编辑令牌描述的功能。此时会显示闭合的锁 ，表明无法编辑或删除令牌。铅笔 和垃圾桶 也会消失。
  • 单击闭合的锁 解锁令牌，可启用删除令牌和编辑令牌描述的功能。此时会显示打开的锁 ，表明已启用编辑和删除令牌的功能。铅笔 和垃圾桶 也会再次显示。

删除访问令牌

您可以一次性删除单个令牌、多个令牌，或列表中的所有令牌。如果无需维护之前的令牌以备引用，则可以将其删除，以消除令牌列表中的混乱。但是，务必谨慎对待删除令牌的任何决定，并且只在确认不再在任何情景下使用该令牌时才予以删除，因为删除操作是永久的且无法撤销。

删除单个令牌

  1. 单击令牌旁边的垃圾箱图标 。此时会显示删除 # 个令牌？对话框，让您确认删除。
  2. 单击删除令牌。此时会永久删除并从列表中移除令牌。

    3. 注意

    删除令牌的操作是永久的且无法撤销。如果将某个正在使用的令牌删除，则使用该令牌的任何进程都会失败。如果错误删除了某个令牌，则需要重新创建令牌，并将其重新引入到受影响的应用程序或脚本中。

删除多个令牌

  1. 单击要删除的多个令牌旁边的复选框。令牌列表上方会出现一个红色按钮，表明要删除的令牌数量。
  2. 单击删除 # 个令牌。此时会显示删除 # 个令牌？对话框，让您确认删除。
  3. 单击删除 # 个令牌。此时会永久删除并从列表中移除令牌。

    4. 注意

    删除令牌的操作是永久的且无法撤销。如果将某个正在使用的令牌删除，则使用该令牌的任何进程都会失败。如果错误删除了某个令牌，则需要重新创建令牌，并将其重新引入到受影响的应用程序或脚本中。

删除所有令牌

  1. 选中信息图标 旁边的复选框。这样会自动选择列表中的所有令牌，并且令牌列表上方会出现一个红色按钮，表明要删除的令牌数量。
  2. 单击删除 # 个令牌。此时会显示删除 # 个令牌？对话框，让您确认删除。
  3. 单击删除 # 个令牌。此时会永久删除并从列表中移除令牌。

    4. 注意

    删除令牌的操作是永久的且无法撤销。如果将某个正在使用的令牌删除，则使用该令牌的任何进程都会失败。如果错误删除了某个令牌，则需要重新创建令牌，并将其重新引入到受影响的应用程序或脚本中。

处理即将到期的令牌

系统将会发送多个提醒，直至令牌被删除或过期。令牌创建者会在令牌到期日期之前 30 天、5 天和 1 天分别收到电子邮件通知。令牌到期后，还会发送电子邮件通知。令牌到期后，除非使用新令牌替换已到期的令牌，否则，依赖于此令牌的所有进程都会失败。

使用新令牌替换即将到期的令牌

为避免进程失败，需要使用新令牌来替换即将到期和已经到期的令牌。要更新令牌，则需创建一个新令牌。请参阅创建访问令牌。创建新令牌后，找到使用即将到期令牌的所有实例，并将即将到期的令牌替换为新建令牌。

删除即将到期的令牌

删除即将到期的令牌，可停止接收关于令牌即将到期的通知，并移除不再需要引用的所有令牌。请参阅删除访问令牌。

注意

删除令牌的操作是永久的且无法撤销。如果将某个正在使用的令牌删除，则使用该令牌的任何进程都会失败。如果错误删除了某个令牌，则需要重新创建令牌，并将其重新引入到受影响的应用程序或脚本中。