生成 API 授权令牌

生成 API 授权令牌以向 Cloud Pak for Data API 进行认证。

令牌和 API 密钥将接受授权检查。 API 端点的调用取决于在 Cloud Pak for Data 平台和服务中授予的角色和许可权。

准备工作

要获取 API 授权令牌，必须使用 Cloud Pak for Data Web 客户机生成 API 密钥。 有关更多信息，请参阅生成用于认证的 API 密钥。 当 SAML 2.0 配置为 Web SSO 时，可以使用 Web 客户机。

您还可以使用 apiKey 端点以编程方式生成 API 密钥，但此端点需要 Bearer 令牌，建议不要这样做。

关于本任务

您可以使用 username 和 api_key 来生成 ZenApiKey 授权令牌以调用 Cloud Pak for Data API。 此方法需要对端点进行一次 API 调用。

注: ZenApiKey 不会到期，但您可以随时将其撤销并重新生成，以提高安全性。

过程

要生成 API 授权令牌，请执行以下步骤。

  1. 使用以下命令生成 ZenApiKey 令牌。
    echo "<username>:<api_key>" | base64

    将 <username> 和 <api_key> 替换为适用于您环境的正确值。

  2. 可选: 如果需要在多种情况下使用 ZenApiKey 令牌，请将令牌从步骤 1 中的响应导出到环境变量。
    export TOKEN=<base64-encoded-user-api-pair>
  3. 使用 ZenApiKey 令牌向端点进行认证。
    curl -H "Authorization: ZenApiKey ${TOKEN}" "https://<cpd_instance_route>/<endpoint>"

    有关更多信息，请参阅 Cloud Pak for Data Platform API 中的 认证 。

下一步操作

对于大多数 Cloud Pak for Data 端点，您可以在后续 API 调用的授权头中使用生成的 API 授权令牌。

curl -H "Authorization: ZenApiKey ${TOKEN}" "https://<cpd_instance_route>/<endpoint>"