19 个稳定版本 (4 个主要版本)
5.0.4+20240304 | 2024年3月5日 |
---|---|
3.1.0+20220303 | 2022年4月26日 |
3.0.0+20220303 | 2022年3月8日 |
2.0.4+20210324 | 2021年4月14日 |
0.3.6+20160831 | 2016年9月11日 |
2825 在 网络编程
每月401次 下载
1.5MB
22K SLoC
androidenterprise1
命令行界面(CLI)允许您从终端舒适地使用 Google Android Enterprise 服务的多数功能。
默认情况下,所有输出都打印到标准输出,但可以通过设置标志将其定向到文件,而不受您的 shell 能力限制。错误将打印到标准错误,并导致程序退出码不为零。
如果请求数据结构,则这些数据结构将以格式化的 JSON 返回,以便作为其他工具的输入。
有关 Android Enterprise API 的其他所有信息,请参阅官方文档网站。
安装和源代码
使用 cargo 安装命令行界面:
cargo install google-androidenterprise1-cli
在 github 上找到源代码。
用法
本文档是从修订版 20240304 的 Android Enterprise API 生成的。CLI 版本为 5.0.4。
androidenterprise1 [options]
devices
force-report-upload <enterprise-id> <user-id> <device-id> [-p <v>]...
get <enterprise-id> <user-id> <device-id> [-p <v>]... [-o <out>]
get-state <enterprise-id> <user-id> <device-id> [-p <v>]... [-o <out>]
list <enterprise-id> <user-id> [-p <v>]... [-o <out>]
set-state <enterprise-id> <user-id> <device-id> (-r <kv>)... [-p <v>]... [-o <out>]
update <enterprise-id> <user-id> <device-id> (-r <kv>)... [-p <v>]... [-o <out>]
enterprises
acknowledge-notification-set [-p <v>]...
complete-signup [-p <v>]... [-o <out>]
create-enrollment-token <enterprise-id> [-p <v>]... [-o <out>]
create-web-token <enterprise-id> (-r <kv>)... [-p <v>]... [-o <out>]
enroll <token> (-r <kv>)... [-p <v>]... [-o <out>]
generate-signup-url [-p <v>]... [-o <out>]
get <enterprise-id> [-p <v>]... [-o <out>]
get-service-account <enterprise-id> [-p <v>]... [-o <out>]
get-store-layout <enterprise-id> [-p <v>]... [-o <out>]
list <domain> [-p <v>]... [-o <out>]
pull-notification-set [-p <v>]... [-o <out>]
send-test-push-notification <enterprise-id> [-p <v>]... [-o <out>]
set-account <enterprise-id> (-r <kv>)... [-p <v>]... [-o <out>]
set-store-layout <enterprise-id> (-r <kv>)... [-p <v>]... [-o <out>]
unenroll <enterprise-id> [-p <v>]...
entitlements
delete <enterprise-id> <user-id> <entitlement-id> [-p <v>]...
get <enterprise-id> <user-id> <entitlement-id> [-p <v>]... [-o <out>]
list <enterprise-id> <user-id> [-p <v>]... [-o <out>]
update <enterprise-id> <user-id> <entitlement-id> (-r <kv>)... [-p <v>]... [-o <out>]
grouplicenses
get <enterprise-id> <group-license-id> [-p <v>]... [-o <out>]
list <enterprise-id> [-p <v>]... [-o <out>]
grouplicenseusers
list <enterprise-id> <group-license-id> [-p <v>]... [-o <out>]
installs
delete <enterprise-id> <user-id> <device-id> <install-id> [-p <v>]...
get <enterprise-id> <user-id> <device-id> <install-id> [-p <v>]... [-o <out>]
list <enterprise-id> <user-id> <device-id> [-p <v>]... [-o <out>]
update <enterprise-id> <user-id> <device-id> <install-id> (-r <kv>)... [-p <v>]... [-o <out>]
managedconfigurationsfordevice
delete <enterprise-id> <user-id> <device-id> <managed-configuration-for-device-id> [-p <v>]...
get <enterprise-id> <user-id> <device-id> <managed-configuration-for-device-id> [-p <v>]... [-o <out>]
list <enterprise-id> <user-id> <device-id> [-p <v>]... [-o <out>]
update <enterprise-id> <user-id> <device-id> <managed-configuration-for-device-id> (-r <kv>)... [-p <v>]... [-o <out>]
managedconfigurationsforuser
delete <enterprise-id> <user-id> <managed-configuration-for-user-id> [-p <v>]...
get <enterprise-id> <user-id> <managed-configuration-for-user-id> [-p <v>]... [-o <out>]
list <enterprise-id> <user-id> [-p <v>]... [-o <out>]
update <enterprise-id> <user-id> <managed-configuration-for-user-id> (-r <kv>)... [-p <v>]... [-o <out>]
managedconfigurationssettings
list <enterprise-id> <product-id> [-p <v>]... [-o <out>]
permissions
get <permission-id> [-p <v>]... [-o <out>]
products
approve <enterprise-id> <product-id> (-r <kv>)... [-p <v>]...
generate-approval-url <enterprise-id> <product-id> [-p <v>]... [-o <out>]
get <enterprise-id> <product-id> [-p <v>]... [-o <out>]
get-app-restrictions-schema <enterprise-id> <product-id> [-p <v>]... [-o <out>]
get-permissions <enterprise-id> <product-id> [-p <v>]... [-o <out>]
list <enterprise-id> [-p <v>]... [-o <out>]
unapprove <enterprise-id> <product-id> [-p <v>]...
serviceaccountkeys
delete <enterprise-id> <key-id> [-p <v>]...
insert <enterprise-id> (-r <kv>)... [-p <v>]... [-o <out>]
list <enterprise-id> [-p <v>]... [-o <out>]
storelayoutclusters
delete <enterprise-id> <page-id> <cluster-id> [-p <v>]...
get <enterprise-id> <page-id> <cluster-id> [-p <v>]... [-o <out>]
insert <enterprise-id> <page-id> (-r <kv>)... [-p <v>]... [-o <out>]
list <enterprise-id> <page-id> [-p <v>]... [-o <out>]
update <enterprise-id> <page-id> <cluster-id> (-r <kv>)... [-p <v>]... [-o <out>]
storelayoutpages
delete <enterprise-id> <page-id> [-p <v>]...
get <enterprise-id> <page-id> [-p <v>]... [-o <out>]
insert <enterprise-id> (-r <kv>)... [-p <v>]... [-o <out>]
list <enterprise-id> [-p <v>]... [-o <out>]
update <enterprise-id> <page-id> (-r <kv>)... [-p <v>]... [-o <out>]
users
delete <enterprise-id> <user-id> [-p <v>]...
generate-authentication-token <enterprise-id> <user-id> [-p <v>]... [-o <out>]
get <enterprise-id> <user-id> [-p <v>]... [-o <out>]
get-available-product-set <enterprise-id> <user-id> [-p <v>]... [-o <out>]
insert <enterprise-id> (-r <kv>)... [-p <v>]... [-o <out>]
list <enterprise-id> <email> [-p <v>]... [-o <out>]
revoke-device-access <enterprise-id> <user-id> [-p <v>]...
set-available-product-set <enterprise-id> <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
update <enterprise-id> <user-id> (-r <kv>)... [-p <v>]... [-o <out>]
webapps
delete <enterprise-id> <web-app-id> [-p <v>]...
get <enterprise-id> <web-app-id> [-p <v>]... [-o <out>]
insert <enterprise-id> (-r <kv>)... [-p <v>]... [-o <out>]
list <enterprise-id> [-p <v>]... [-o <out>]
update <enterprise-id> <web-app-id> (-r <kv>)... [-p <v>]... [-o <out>]
androidenterprise1 --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 文件中,这些文件以前缀 androidenterprise1-
开头。您可以使用 --config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落中提供了有关各种类型持久数据的更多信息。
身份验证
大多数 API 需要用户对任何请求进行身份验证。如果是这样,作用域 确定了授予的权限集。这些通常是仅限于 只读 或 完全访问。
如果没有设置,系统将自动选择最小可行的作用域,例如,当调用只读方法时,它将只请求只读作用域。您可以使用 --scope
标志直接指定作用域。所有适用的作用域均在相应方法的 CLI 文档中记录。
首次使用范围时,会要求用户授权。按照 CLI 的说明进行授权或拒绝。
如果用户已验证某个范围,相关数据将作为 JSON 格式存储在配置目录中,例如 ~/.google-service-cli/androidenterprise1-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授权,请参阅 官方文档。
应用程序密钥
为了允许任何应用程序使用 Google 服务,需要使用 Google 开发者控制台 进行注册。然后逐个为应用程序启用可能使用的 API。大多数 API 可以免费使用,并设有每日配额。
为了在不强制用户注册自己的应用程序的情况下更方便地使用 CLI,CLI 配置了一个默认的应用程序密钥。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过将自定义密钥文件放在此位置来解决这个问题: ~/.google-service-cli/androidenterprise1-secret.json
,假设已为它启用了所需的 androidenterprise API。此类密钥文件可以在 Google 开发者控制台 的 APIs & auth -> Credentials -> Download JSON 中下载并直接使用。
有关如何设置 Google 项目和启用 API 的更多信息,请参阅 官方文档。
调试
尽管 CLI 尽力提供可用的错误消息,但有时可能需要了解导致特定问题确切原因。这是通过允许所有客户端-服务器通信以原始形式输出到标准错误。
使用 --debug
标志将以 Debug
表示法将错误打印到标准错误。
您可以考虑将标准错误重定向到文件以方便使用,例如 androidenterprise1 --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~20–34MB
~594K SLoC