oslogin1-beta 命令行界面（CLI）允许您从终端舒适地使用 Google Cloud OS Login 服务的几乎所有功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接重定向到文件，而无需考虑您的 shell 功能。错误将打印到标准错误，并导致程序退出代码不为零。

如果请求数据结构，则这些数据结构将以格式化的 JSON 返回，以便作为其他工具的输入使用。

有关 Cloud OS Login API 的其他所有信息，请参阅官方文档网站。

安装和源代码

使用 cargo 安装命令行界面：

cargo install google-oslogin1_beta-cli

在 GitHub 上找到源代码。

用法

本文档是根据 Cloud OS Login API 在 20240225 版本中生成的。CLI 的版本是 5.0.4。

oslogin1-beta [options]
        users
                get-login-profile <name> [-p <v>]... [-o <out>]
                import-ssh-public-key <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-delete <name> [-p <v>]... [-o <out>]
                projects-locations-sign-ssh-public-key <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                projects-zones-sign-ssh-public-key <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                ssh-public-keys-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                ssh-public-keys-delete <name> [-p <v>]... [-o <out>]
                ssh-public-keys-get <name> [-p <v>]... [-o <out>]
                ssh-public-keys-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  oslogin1-beta --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 目录中存储所有持久数据，该目录以 oslogin1-beta- 前缀的 JSON 文件开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

当第一次使用作用域时，系统会要求用户授权。根据CLI的指示进行授权或拒绝。

如果用户已验证作用域，相关信息将以JSON格式存储在配置目录中，例如：~/.google-service-cli/oslogin1-beta-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

为了允许任何应用程序使用Google服务，它需要通过Google开发者控制台进行注册。应用程序可能使用的API将逐一启用。大多数API可以免费使用，并有限额。

为了在不强制用户注册自己的应用程序的情况下更方便地使用CLI，CLI自带一个默认应用程序密钥，并根据需要进行配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

使用--debug标志，错误将以Debug表示形式输出到标准错误。

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