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月14日 |
1.0.8+20181003 | 2018年10月14日 |
3 in #iap
220 monthly downloads
155KB
2K SLoC
该iap1-beta1
命令行界面(CLI)允许您从终端方便地使用Google Cloud IAP服务的几乎所有功能。
默认情况下,所有输出都会打印到标准输出,但可以通过设置标志将其重定向到与shell功能无关的文件。错误将打印到标准错误,并导致程序退出码非零。
如果请求数据结构,则这些结构将作为格式化的JSON返回,以便作为其他工具的输入。
有关云IAP API的所有其他信息,请参阅官方文档网站。
安装和源代码
使用cargo安装命令行界面:
cargo install google-iap1_beta1-cli
用法
本文档是根据修订版20240224的Cloud IAP API生成的。CLI版本为5.0.4。
iap1-beta1 [options]
methods
get-iam-policy <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>]
iap1-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
目录中存储所有持久数据,目录中的文件以iap1-beta1-
为前缀。您可以使用--config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落中提供了有关各种持久数据的更多信息。
身份验证
大多数API需要用户对任何请求进行身份验证。如果是这样,则作用域确定授予的权限集。这些通常不超过只读或完全访问。
如果没有设置,系统将自动选择最小的可行作用域,例如,当调用一个只读方法时,它将只请求只读作用域。您可以使用--scope
标志直接指定作用域。所有适用的作用域在相应方法的CLI文档中有记录。
首次使用作用域时,用户会被要求授权。按照CLI提供的说明授予权限或拒绝。
如果用户认证了作用域,相关的信息将被存储在配置目录中,格式为JSON,例如:~/.google-service-cli/iap1-beta1-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授予的认证,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用谷歌服务,它需要使用谷歌开发者控制台进行注册。应用程序可能使用的API将逐个启用。大多数API可以免费使用,并且有每日配额。
为了在不强制用户注册自己的应用程序的情况下更方便地使用CLI,CLI自带了一个默认应用程序密钥,并进行相应配置。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过将您自己的密钥文件放在此位置来解决这个问题:~/.google-service-cli/iap1-beta1-secret.json
,前提是已为它启用了所需的iap API。这样的密钥文件可以在Google开发者控制台的APIs & auth -> Credentials -> Download JSON中下载,并直接使用。
有关如何设置谷歌项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽力提供可用的错误消息,但有时可能需要知道导致特定问题的确切原因。这通过允许将所有客户端-服务器通信以原样输出到标准错误来完成。
使用--debug
标志,将使用Debug
表示法将错误打印到标准错误。
您可以考虑将标准错误重定向到文件以提高方便性,例如:iap1-beta1 --debug <resource> <method> [options] 2>debug.txt
。
依赖关系
~20–32MB
~590K SLoC