11个稳定版本 (3个主要版本)

5.0.4+20240224 2024年3月5日
3.1.0+20220225 2022年4月26日
3.0.0+20220225 2022年3月8日
2.0.4+20210326 2021年4月15日
1.0.10+20190628 2019年7月6日

Web编程 中排名 2410

Download history 18/week @ 2024-03-09 1/week @ 2024-03-16 86/week @ 2024-03-30 15/week @ 2024-04-06 1/week @ 2024-05-18

每月下载次数 221

MIT 许可证

495KB
6.5K SLoC

iap1 命令行界面(CLI)允许您在终端中方便地使用Google Cloud IAP服务的几乎所有功能。

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

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

有关Cloud IAP API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-iap1-cli

GitHub上找到源代码。

用法

此文档是根据修订版 20240224 的Cloud IAP API生成的。CLI版本为 5.0.4

iap1 [options]
        methods
                get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                get-iap-settings <name> [-p <v>]... [-o <out>]
                set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                update-iap-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
                validate-attribute-expression <name> [-p <v>]... [-o <out>]
        projects
                brands-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                brands-get <name> [-p <v>]... [-o <out>]
                brands-identity-aware-proxy-clients-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                brands-identity-aware-proxy-clients-delete <name> [-p <v>]... [-o <out>]
                brands-identity-aware-proxy-clients-get <name> [-p <v>]... [-o <out>]
                brands-identity-aware-proxy-clients-list <parent> [-p <v>]... [-o <out>]
                brands-identity-aware-proxy-clients-reset-secret <name> (-r <kv>)... [-p <v>]... [-o <out>]
                brands-list <parent> [-p <v>]... [-o <out>]
                iap-tunnel-locations-dest-groups-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                iap-tunnel-locations-dest-groups-delete <name> [-p <v>]... [-o <out>]
                iap-tunnel-locations-dest-groups-get <name> [-p <v>]... [-o <out>]
                iap-tunnel-locations-dest-groups-list <parent> [-p <v>]... [-o <out>]
                iap-tunnel-locations-dest-groups-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  iap1 --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 目录中的 JSON 文件中,文件名以 iap1- 前缀开头。您可以使用 --config-dir 标志在每次调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用作用域时,系统会要求用户授权。按照CLI的说明授权权限,或拒绝授权。

如果用户认证了作用域,相关的信息将作为JSON存储在配置目录中,例如~/.google-service-cli/iap1-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

使用--debug标志,将使用Debug表示法将错误打印到标准错误。

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

依赖项

~19–31MB
~580K SLoC