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

5.0.4+20240226 2024年3月5日
3.1.0+20220301 2022年4月26日
3.0.0+20220301 2022年3月8日
2.0.4+20210319 2021年4月14日
1.0.10+20190626 2019年7月7日

#26 in #standard-error

MIT 许可证

1MB
12K SLoC

accesscontextmanager1 命令行界面(CLI)允许您从终端舒适地使用 Google Access Context Manager 服务的几乎所有功能。

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

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

有关 Access Context Manager API 的其他所有信息,请参阅官方文档网站

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-accesscontextmanager1-cli

GitHub 上找到源代码。

用法

此文档是从 访问上下文管理器 API 的 20240226 版本生成的。CLI 版本为 5.0.4

accesscontextmanager1 [options]
        access-policies
                access-levels-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                access-levels-delete <name> [-p <v>]... [-o <out>]
                access-levels-get <name> [-p <v>]... [-o <out>]
                access-levels-list <parent> [-p <v>]... [-o <out>]
                access-levels-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                access-levels-replace-all <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                access-levels-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                authorized-orgs-descs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                authorized-orgs-descs-delete <name> [-p <v>]... [-o <out>]
                authorized-orgs-descs-get <name> [-p <v>]... [-o <out>]
                authorized-orgs-descs-list <parent> [-p <v>]... [-o <out>]
                authorized-orgs-descs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                service-perimeters-commit <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                service-perimeters-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                service-perimeters-delete <name> [-p <v>]... [-o <out>]
                service-perimeters-get <name> [-p <v>]... [-o <out>]
                service-perimeters-list <parent> [-p <v>]... [-o <out>]
                service-perimeters-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                service-perimeters-replace-all <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                service-perimeters-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
        operations
                cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list <name> [-p <v>]... [-o <out>]
        organizations
                gcp-user-access-bindings-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                gcp-user-access-bindings-delete <name> [-p <v>]... [-o <out>]
                gcp-user-access-bindings-get <name> [-p <v>]... [-o <out>]
                gcp-user-access-bindings-list <parent> [-p <v>]... [-o <out>]
                gcp-user-access-bindings-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        services
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
  accesscontextmanager1 --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 目录中存储所有持久数据,该目录以 accesscontextmanager1- 为前缀的 JSON 文件。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,系统会询问用户权限。请按照CLI给出的指示授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~577K SLoC