设置 API 密钥访问权限

API 密钥身份验证为访问 ALM API 的外部应用程序提供了安全的身份验证机制。

API 密钥身份验证概述

API 密钥身份验证为访问 ALM API 的外部应用程序提供了安全的身份验证机制。

  • 每个 API 密钥都包含一个客户端 ID 和一个 API 密钥，供应用程序在进行身份验证时使用。
  • 每个 API 密钥都与一个 ALM 用户相关联。因此，当应用程序使用 API 密钥访问 ALM 时，应用程序受到其用户权限的限制。
  • 您只能使用活动 API 密钥来访问 ALM。

  • 如果您在 ALM 中停用或删除用户，用户的 API 密钥也会被删除。

当编写 ALM 扩展或 API 脚本时，请从管理员处获取客户端 ID 和 API 密钥，将其用于身份验证。有关使用 REST 和 OTA 时 API 密钥身份验证的详细信息，请参阅 开发人员帮助。

返回页首

使用 API 密钥

作为 ALM 站点管理员，您可以创建、删除、撤销和重新生成 API 密钥。作为基本用户，您可以对与您关联的 API 密钥执行的操作取决于 APIKEY_SELF_SERVICE_LEVEL 站点参数的设置。有关参数的详细信息，请参阅 ALM 站点参数。

SaaS: 当管理 API 密钥时，选项将因当前登录的客户管理员而异。

  1. (可选) 定义 API 密钥的到期时间。

    默认情况下，除非被撤销，否则 API 密钥不会到期。要设置到期时间，您可以定义 APIKEY_EXPIRE_DAYS 站点参数。此参数不会影响现有 API 密钥。

    有关详细信息，请参阅 ALM 站点参数。

  2. 在 Application Lifecycle Management“选项”窗口上，单击“API 密钥”链接。在“API 密钥登录”窗口中，输入用户名和密码。

  3. 管理 API 密钥。

    创建 API 密钥

    要创建 API 密钥，请执行以下操作:

    1. 单击“API 访问”。

    2. 在“API 密钥名称”字段中，提供密钥的名称。

    3. 在“用户”字段中，选择要与密钥关联的用户。用户权限将授予使用此 API 密钥访问 ALM 的任何应用程序。

      SaaS: 可用用户的列表因当前登录的客户管理员而异。

    4. 单击“创建”。

      您会收到“客户端 ID”和“API 密钥”，您需要将其提供给需要使用此密钥进行身份验证的人员。请对这些内容进行安全记录，因为无法再次检索密钥。如果丢失，请撤销密钥并重新生成它以接收新的密钥。

    您可以为用户创建的 API 密钥的最大数量受 APIKEY_MAX_NUM_PER_USER 站点参数的限制。一旦达到限制，您将无法为用户创建或重新生成 API 密钥。有关参数的详细信息，请参阅 ALM 站点参数。
    删除 API 密钥

    要删除 API 密钥，请从列表中选择密钥并单击“删除密钥”。

    API 密钥所有者将收到有关密钥被删除的通知电子邮件。如果您是具有 API 密钥完全控制权的基本用户，则删除您自己的 API 密钥时不会收到通知。
    撤销 API 密钥

    当您要暂时阻止 API 密钥访问 ALM 时，撤销 API 密钥。

    要撤销 API 密钥，请从列表中选择密钥并单击“撤销密钥”。

    API 密钥所有者将收到有关密钥被撤销的通知电子邮件。如果您是具有 API 密钥完全控制权的基本用户，则撤销您自己的 API 密钥时不会收到通知。
    重新生成 API 密钥

    您可以重新生成已撤销的 API 密钥，从而重新激活密钥并提供新的用于原始客户端 ID 的 API 密钥。

    要重新生成 API 密钥，请从列表中选择密钥并单击“重新生成密钥”。
    刷新 单击刷新以刷新 API 密钥列表。
    查看到期日期

    API 密钥到期时，将显示“到期日期”列。

    如果 API 密钥在 10 天内到期，则到期日期旁会显示一条警告: 将于 <N> 天后到期。API 密钥将在到期日期的午夜 (晚上12:00) 到期。

返回页首