21 个稳定版本 (4 个主要版本)

5.0.4+20180723 2024 年 3 月 5 日
3.1.0+20180723 2022 年 4 月 26 日
3.0.0+20180723 2022 年 3 月 8 日
2.0.4+20180723 2021 年 4 月 15 日
0.3.6+20160812 2016 年 9 月 11 日

#1685 in Web 编程

Download history 1/week @ 2024-05-19

每月 457 次下载

MIT 许可证

530KB
7K SLoC

identitytoolkit3 命令行界面(CLI)允许您在终端中舒适地使用 Google 身份工具包服务的多数功能。

默认情况下,所有输出都打印到标准输出,但可以使用标志将其重定向到与您的 shell 功能无关的文件。错误将打印到标准错误,并导致程序的退出代码不为零。

如果请求数据结构,则这些数据结构将以漂亮的打印 JSON 返回,作为其他工具的输入。

有关身份工具包 API 的其他所有信息,请参阅 官方文档网站

安装和源代码

使用 cargo 安装命令行界面:

cargo install google-identitytoolkit3-cli

GitHub 上查找源代码。

用法

此文档是从修订版 20180723Identity Toolkit API 生成的。CLI 的版本为 5.0.4

identitytoolkit3 [options]
        relyingparty
                create-auth-uri (-r <kv>)... [-p <v>]... [-o <out>]
                delete-account (-r <kv>)... [-p <v>]... [-o <out>]
                download-account (-r <kv>)... [-p <v>]... [-o <out>]
                email-link-signin (-r <kv>)... [-p <v>]... [-o <out>]
                get-account-info (-r <kv>)... [-p <v>]... [-o <out>]
                get-oob-confirmation-code (-r <kv>)... [-p <v>]... [-o <out>]
                get-project-config [-p <v>]... [-o <out>]
                get-public-keys [-p <v>]... [-o <out>]
                get-recaptcha-param [-p <v>]... [-o <out>]
                reset-password (-r <kv>)... [-p <v>]... [-o <out>]
                send-verification-code (-r <kv>)... [-p <v>]... [-o <out>]
                set-account-info (-r <kv>)... [-p <v>]... [-o <out>]
                set-project-config (-r <kv>)... [-p <v>]... [-o <out>]
                sign-out-user (-r <kv>)... [-p <v>]... [-o <out>]
                signup-new-user (-r <kv>)... [-p <v>]... [-o <out>]
                upload-account (-r <kv>)... [-p <v>]... [-o <out>]
                verify-assertion (-r <kv>)... [-p <v>]... [-o <out>]
                verify-custom-token (-r <kv>)... [-p <v>]... [-o <out>]
                verify-password (-r <kv>)... [-p <v>]... [-o <out>]
                verify-phone-number (-r <kv>)... [-p <v>]... [-o <out>]
  identitytoolkit3 --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 目录中,以 identitytoolkit3 为前缀的 JSON 文件中。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时,系统会要求用户授权。根据 CLI 的说明授权权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~581K SLoC