5个稳定版本

5.0.4+20240303 2024年3月5日
3.1.0+20220305 2022年4月26日
3.0.0+20220305 2022年3月8日
2.0.4+20210329 2021年4月14日
2.0.0+20210329 2021年4月2日

#2952网络编程

Download history 22/week @ 2024-04-04

每月下载 90

MIT 许可证

425KB
5.5K SLoC

chromepolicy1 命令行界面(CLI)允许您从终端舒适地使用Google Chrome Policy服务的大多数功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-chromepolicy1-cli

github上查找源代码。

用法

此文档是从修订版20240303的Chrome Policy API生成的。CLI版本为5.0.4

chromepolicy1 [options]
        customers
                policies-groups-batch-delete <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policies-groups-batch-modify <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policies-groups-list-group-priority-ordering <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policies-groups-update-group-priority-ordering <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policies-networks-define-certificate <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policies-networks-define-network <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policies-networks-remove-certificate <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policies-networks-remove-network <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policies-orgunits-batch-inherit <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policies-orgunits-batch-modify <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policies-resolve <customer> (-r <kv>)... [-p <v>]... [-o <out>]
                policy-schemas-get <name> [-p <v>]... [-o <out>]
                policy-schemas-list <parent> [-p <v>]... [-o <out>]
        media
                upload <customer> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
  chromepolicy1 --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文件中,以chromepolicy1-为前缀。您可以使用--config-dir标志在每个调用上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时,会提示用户请求权限。按照CLI的指示授予权限或拒绝。

如果用户验证了某个范围,相应的信息将被存储为JSON格式在配置目录中,例如~/.google-service-cli/chromepolicy1-token-.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖项

~20–31MB
~574K SLoC