#google #cli #google-api #access-approval #command-line-interface

app google-accessapproval1_beta1-cli

用于与访问批准(协议v1beta1)交互的完整库

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

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

#248#命令行界面

Download history 83/week @ 2024-04-02

每月下载量:219

MIT 许可证

500KB
6.5K SLoC

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

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

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

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

安装和源代码

使用cargo安装命令行界面:

cargo install google-accessapproval1_beta1-cli

GitHub上查找源代码

用法

本文档是从修订版20200708的Access Approval API生成的。CLI版本为5.0.4

accessapproval1-beta1 [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-list <parent> [-p <v>]... [-o <out>]
                delete-access-approval-settings <name> [-p <v>]... [-o <out>]
                get-access-approval-settings <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-list <parent> [-p <v>]... [-o <out>]
                delete-access-approval-settings <name> [-p <v>]... [-o <out>]
                get-access-approval-settings <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-list <parent> [-p <v>]... [-o <out>]
                delete-access-approval-settings <name> [-p <v>]... [-o <out>]
                get-access-approval-settings <name> [-p <v>]... [-o <out>]
                update-access-approval-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
  accessapproval1-beta1 --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目录中存储所有持久数据,该目录以accessapproval1-beta1-为前缀的JSON文件开头。您可以使用--config-dir标志根据调用更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,系统会要求用户进行授权。按照CLI给出的说明授予权限或拒绝。

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

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

应用程序密钥

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

为了使CLI更易于使用,而不需要强制用户注册自己的应用程序,CLI自带默认应用程序密钥,已相应配置。这也意味着全球范围内的重用可能会耗尽每日配额。

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

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

调试

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

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

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

依赖关系

~20–31MB
~583K SLoC