该recaptchaenterprise1命令行界面（CLI）允许您从终端舒适地使用Google Recaptcha Enterprise服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接导向文件，而不依赖于shell的功能。错误将打印到标准错误，并导致程序退出代码非零。

如果请求数据结构，这些将以美观打印的JSON格式返回，以便作为其他工具的输入。

有关Recaptcha Enterprise API的所有其他信息，请参阅官方文档站点。

安装和源代码

使用cargo安装命令行界面：

cargo install google-recaptchaenterprise1-cli

在GitHub上找到源代码。

用法

本文档是根据Recaptcha Enterprise API在20230115版本中生成的。CLI的版本是5.0.3。

recaptchaenterprise1 [options]
        projects
                assessments-annotate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                assessments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                keys-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                keys-delete <name> [-p <v>]... [-o <out>]
                keys-get <name> [-p <v>]... [-o <out>]
                keys-get-metrics <name> [-p <v>]... [-o <out>]
                keys-list <parent> [-p <v>]... [-o <out>]
                keys-migrate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                keys-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                keys-retrieve-legacy-secret-key <key> [-p <v>]... [-o <out>]
                relatedaccountgroupmemberships-search <project> (-r <kv>)... [-p <v>]... [-o <out>]
                relatedaccountgroups-list <parent> [-p <v>]... [-o <out>]
                relatedaccountgroups-memberships-list <parent> [-p <v>]... [-o <out>]
  recaptchaenterprise1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]

配置

程序将所有持久数据存储在~/.google-service-cli目录中，以recaptchaenterprise1-为前缀的JSON文件中。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

有关各种类型持久数据的更多信息将在以下段落中提供。

身份验证

大多数API要求用户对任何请求进行身份验证。如果是这样，则作用域确定授予的权限集。这些通常不超过只读或完全访问。

如果没有设置，系统将自动选择最小的可行范围，例如在调用只读方法时，它只会请求只读范围。您可以使用 --scope 标志直接指定范围。所有适用的范围都在相应方法的 CLI 文档中进行了说明。

第一次使用范围时，会询问用户权限。根据 CLI 提供的说明授予权限，或拒绝。

如果用户已验证了范围，则相应信息将以 JSON 格式存储在配置目录中，例如 ~/.google-service-cli/recaptchaenterprise1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授予的认证，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用 Google 服务，它需要使用 Google 开发者控制台 进行注册。然后为应用程序逐个启用可能使用的 API。大多数 API 可以免费使用，并且有每日配额。

为了使 CLI 的使用更加方便，而无需强迫任何人注册自己的应用程序，CLI 配置了默认应用程序密钥。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过在此位置放置自己的密钥文件来解决这个问题：~/.google-service-cli/recaptchaenterprise1-secret.json，假设已为它启用了所需的 recaptchaenterprise API。这样的密钥文件可以在 Google 开发者控制台 的 APIs & auth -> Credentials -> Download JSON 下下载并直接使用。

有关如何设置 Google 项目和启用 API 的更多信息，请参阅 官方文档。

调试

尽管 CLI 尽力提供可用的错误消息，但有时可能希望知道导致特定问题的确切原因。这是通过允许将所有客户端服务器通信以 原样 输出到标准错误来实现的。

使用 --debug 标志将错误以 Debug 表示形式打印到标准错误。

您可以考虑将标准错误重定向到文件以方便使用，例如 recaptchaenterprise1 --debug <resource> <method> [options] 2>debug.txt。