cloudidentity1 命令行界面（CLI）允许您从终端舒适地使用大多数Google Cloud Identity服务的功能。

默认情况下，所有输出都打印到标准输出，但可以使用标志将其直接导向文件，而不受您的shell功能的限制。错误将打印到标准错误，并导致程序的退出代码不为零。

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

有关Cloud Identity API的所有其他信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面：

cargo install google-cloudidentity1-cli

在GitHub上找到源代码。

用法

本文档是根据修订版 20240227 中的Cloud Identity API生成的。CLI版本为 5.0.4。

cloudidentity1 [options]
        customers
                userinvitations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                userinvitations-get <name> [-p <v>]... [-o <out>]
                userinvitations-is-invitable-user <name> [-p <v>]... [-o <out>]
                userinvitations-list <parent> [-p <v>]... [-o <out>]
                userinvitations-send <name> (-r <kv>)... [-p <v>]... [-o <out>]
        devices
                cancel-wipe <name> (-r <kv>)... [-p <v>]... [-o <out>]
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                device-users-approve <name> (-r <kv>)... [-p <v>]... [-o <out>]
                device-users-block <name> (-r <kv>)... [-p <v>]... [-o <out>]
                device-users-cancel-wipe <name> (-r <kv>)... [-p <v>]... [-o <out>]
                device-users-client-states-get <name> [-p <v>]... [-o <out>]
                device-users-client-states-list <parent> [-p <v>]... [-o <out>]
                device-users-client-states-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                device-users-delete <name> [-p <v>]... [-o <out>]
                device-users-get <name> [-p <v>]... [-o <out>]
                device-users-list <parent> [-p <v>]... [-o <out>]
                device-users-lookup <parent> [-p <v>]... [-o <out>]
                device-users-wipe <name> (-r <kv>)... [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                wipe <name> (-r <kv>)... [-p <v>]... [-o <out>]
        groups
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                get-security-settings <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                lookup [-p <v>]... [-o <out>]
                memberships-check-transitive-membership <parent> [-p <v>]... [-o <out>]
                memberships-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                memberships-delete <name> [-p <v>]... [-o <out>]
                memberships-get <name> [-p <v>]... [-o <out>]
                memberships-get-membership-graph <parent> [-p <v>]... [-o <out>]
                memberships-list <parent> [-p <v>]... [-o <out>]
                memberships-lookup <parent> [-p <v>]... [-o <out>]
                memberships-modify-membership-roles <name> (-r <kv>)... [-p <v>]... [-o <out>]
                memberships-search-direct-groups <parent> [-p <v>]... [-o <out>]
                memberships-search-transitive-groups <parent> [-p <v>]... [-o <out>]
                memberships-search-transitive-memberships <parent> [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                search [-p <v>]... [-o <out>]
                update-security-settings <name> (-r <kv>)... [-p <v>]... [-o <out>]
        inbound-saml-sso-profiles
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                idp-credentials-add <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                idp-credentials-delete <name> [-p <v>]... [-o <out>]
                idp-credentials-get <name> [-p <v>]... [-o <out>]
                idp-credentials-list <parent> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
        inbound-sso-assignments
                create (-r <kv>)... [-p <v>]... [-o <out>]
                delete <name> [-p <v>]... [-o <out>]
                get <name> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
                patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
  cloudidentity1 --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文件中存储所有持久数据，文件名以cloudidentity1-开头。您可以使用--config-dir标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，会要求用户授权。根据CLI的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

您可以将标准错误重定向到文件，以便于使用，例如：cloudidentity1 --debug <resource> <method> [options] 2>debug.txt。