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

5.0.4+20240223 2024年3月5日
3.1.0+20220225 2022年4月26日
3.0.0+20220225 2022年3月8日
2.0.4+20210318 2021年4月14日
1.0.14+20200708 2020年7月10日

#2914 in 网络编程

Download history 15/week @ 2024-03-10 63/week @ 2024-03-31 2/week @ 2024-04-07 1/week @ 2024-05-19

每月下载量105次

MIT 许可证

620KB
8K SLoC

通过命令行界面(CLI)使用户能够在终端中方便地使用Google访问审批(Access Approval)服务的多数功能。

默认情况下,所有输出都打印到标准输出,但可以使用标志将其重定向到文件,而无需依赖于shell的功能。错误将打印到标准错误,并导致程序退出码非零。

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

有关访问审批API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面:

cargo install google-accessapproval1-cli

github上找到源代码

使用方法

本文档是根据修订版20240223访问审批 API生成的。CLI版本为5.0.4

accessapproval1 [options]
        folders
                approval-requests-approve <name> (-r <kv>)... [-p <v>]... [-o <out>]
                approval-requests-dismiss <name> (-r <kv>)... [-p <v>]... [-o <out>]
                approval-requests-get <name> [-p <v>]... [-o <out>]
                approval-requests-invalidate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                approval-requests-list <parent> [-p <v>]... [-o <out>]
                delete-access-approval-settings <name> [-p <v>]... [-o <out>]
                get-access-approval-settings <name> [-p <v>]... [-o <out>]
                get-service-account <name> [-p <v>]... [-o <out>]
                update-access-approval-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
        organizations
                approval-requests-approve <name> (-r <kv>)... [-p <v>]... [-o <out>]
                approval-requests-dismiss <name> (-r <kv>)... [-p <v>]... [-o <out>]
                approval-requests-get <name> [-p <v>]... [-o <out>]
                approval-requests-invalidate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                approval-requests-list <parent> [-p <v>]... [-o <out>]
                delete-access-approval-settings <name> [-p <v>]... [-o <out>]
                get-access-approval-settings <name> [-p <v>]... [-o <out>]
                get-service-account <name> [-p <v>]... [-o <out>]
                update-access-approval-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                approval-requests-approve <name> (-r <kv>)... [-p <v>]... [-o <out>]
                approval-requests-dismiss <name> (-r <kv>)... [-p <v>]... [-o <out>]
                approval-requests-get <name> [-p <v>]... [-o <out>]
                approval-requests-invalidate <name> (-r <kv>)... [-p <v>]... [-o <out>]
                approval-requests-list <parent> [-p <v>]... [-o <out>]
                delete-access-approval-settings <name> [-p <v>]... [-o <out>]
                get-access-approval-settings <name> [-p <v>]... [-o <out>]
                get-service-account <name> [-p <v>]... [-o <out>]
                update-access-approval-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
  accessapproval1 --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文件中,这些文件以accessapproval1-为前缀。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时,会询问用户权限。按照CLI给出的指示授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~19–31MB
~578K SLoC