MCP Tools Reference: Android Device Management MCP Server

工具:list_enterprises

列出调用者可访问的企业。

以下示例演示了如何使用 curl 调用 list_enterprises MCP 工具。

Curl 请求
                  
curl --location 'https://androidmanagement.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_enterprises",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

输入架构

请求列出 EMM 管理的企业。

ListEnterprisesRequest

JSON 表示法
{
  "projectId": string,
  "pageSize": integer,
  "pageToken": string,
  "view": enum (EnterpriseView)
}
字段
projectId

string

必需。管理企业的 EMM 的 Cloud 项目 ID。

pageSize

integer

请求的页面大小。实际页面大小可能会固定为最小值或最大值。

pageToken

string

标识服务器返回的结果页面的令牌。

view

enum (EnterpriseView)

指定要返回哪些企业字段。此方法仅支持 BASIC

输出架构

针对列出企业的请求的响应。

ListEnterprisesResponse

JSON 表示法
{
  "enterprises": [
    {
      object (Enterprise)
    }
  ],
  "nextPageToken": string
}
字段
enterprises[]

object (Enterprise)

企业列表。

nextPageToken

string

如果还有更多结果,则为用于检索下一页结果的令牌。

企业

JSON 表示法
{
  "name": string,
  "enabledNotificationTypes": [
    enum (NotificationType)
  ],
  "pubsubTopic": string,
  "primaryColor": integer,
  "logo": {
    object (ExternalData)
  },
  "enterpriseDisplayName": string,
  "termsAndConditions": [
    {
      object (TermsAndConditions)
    }
  ],
  "appAutoApprovalEnabled": boolean,
  "signinDetails": [
    {
      object (SigninDetail)
    }
  ],
  "contactInfo": {
    object (ContactInfo)
  },
  "googleAuthenticationSettings": {
    object (GoogleAuthenticationSettings)
  },
  "enterpriseType": enum (EnterpriseType),
  "managedGooglePlayAccountsEnterpriseType": enum (ManagedGooglePlayAccountsEnterpriseType),
  "managedGoogleDomainType": enum (ManagedGoogleDomainType)
}
字段
name

string

服务器在创建过程中生成的企业的名称,格式为 enterprises/{enterpriseId}

enabledNotificationTypes[]

enum (NotificationType)

为企业启用的 Google Pub/Sub 通知的类型。

pubsubTopic

string

Pub/Sub 通知发布到的主题,格式为 projects/{project}/topics/{topic}。仅在启用 Pub/Sub 通知时,此字段才是必需的。

primaryColor

integer

一种 RGB 格式的颜色,用于指示要在设备管理应用界面中显示的主色调。颜色分量存储为 (red << 16) | (green << 8) | blue,其中每个分量的值介于 0 到 255 之间(含边界值)。

logo

object (ExternalData)

在设备配置期间显示为徽标的图片。支持的类型包括:image/bmp、image/gif、image/x-ico、image/jpeg、image/png、image/webp、image/vnd.wap.wbmp、image/x-adobe-dng。

enterpriseDisplayName

string

向用户显示的企业名称。此字段的最大长度为 100 个字符。

termsAndConditions[]

object (TermsAndConditions)

为相应企业配置设备时必须接受的条款及条件。系统会为该列表中的每个值生成一个术语页面。

appAutoApprovalEnabled
(deprecated)

boolean

已弃用且未使用。

signinDetails[]

object (SigninDetail)

企业的登录详细信息。

contactInfo

object (ContactInfo)

EMM 管理的企业的企业联系信息。

googleAuthenticationSettings

object (GoogleAuthenticationSettings)

Google 提供的用户身份验证的设置。

enterpriseType

enum (EnterpriseType)

仅限输出。企业的类型。

managedGooglePlayAccountsEnterpriseType

enum (ManagedGooglePlayAccountsEnterpriseType)

仅限输出。Google Play 企业版账号集的类型。

managedGoogleDomainType

enum (ManagedGoogleDomainType)

仅限输出。受管理的 Google 网域的类型。

Int32Value

JSON 表示法
{
  "value": integer
}
字段
value

integer

int32 值。

ExternalData

JSON 表示法
{
  "url": string,
  "sha256Hash": string
}
字段
url

string

数据的绝对网址,必须使用 http 或 https 架构。Android Device Policy 不会在 GET 请求中提供任何凭据,因此该网址必须可公开访问。在网址中添加随机的长组件可能有助于防止攻击者发现该网址。

sha256Hash

string

相应网址中托管的内容的 base-64 编码 SHA-256 哈希。如果内容与此哈希值不一致,Android Device Policy 将不会使用相应数据。

TermsAndConditions

JSON 表示法
{
  "header": {
    object (UserFacingMessage)
  },
  "content": {
    object (UserFacingMessage)
  }
}
字段
header

object (UserFacingMessage)

显示在 HTML 内容上方的简短标题。

content

object (UserFacingMessage)

格式正确的 HTML 字符串。它将在客户端上使用 android.text.Html#fromHtml 进行解析。

UserFacingMessage

JSON 表示法
{
  "localizedMessages": {
    string: string,
    ...
  },
  "defaultMessage": string
}
字段
localizedMessages

map (key: string, value: string)

一个包含 <语言区域设置,消息> 对的映射,其中语言区域设置是格式正确的 BCP 47 语言代码,例如 en-US、es-ES 或 fr。

包含一系列 "key": value 对的对象。示例:{ "name": "wrench", "mass": "1.3kg", "count": "3" }

defaultMessage

string

如果未指定任何本地化消息,或者用户的语言区域与任何本地化消息都不匹配,则显示的默认消息。如果提供了任何本地化消息,则必须提供默认消息。

LocalizedMessagesEntry

JSON 表示法
{
  "key": string,
  "value": string
}
字段
key

string

value

string

SigninDetail

JSON 表示法
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "defaultStatus": enum (SigninDetailDefaultStatus),

  // Union field _token_tag can be only one of the following:
  "tokenTag": string
  // End of list of possible types for union field _token_tag.
}
字段
signinUrl

string

当设备通过登录注册令牌完成配置时,用于身份验证的登录网址。登录端点应通过以下形式的网址完成身份验证流程:https://enterprise.google.com/android/enroll?et= (成功登录)或 https://enterprise.google.com/android/enroll/invalid(登录失败)。

signinEnrollmentToken

string

用于触发自定义登录流程的企业范围注册令牌。此字段是服务器生成的只读字段。

qrCode

string

一个 JSON 字符串,其 UTF-8 表示形式可用于生成二维码,以使用此注册令牌注册设备。如需使用 NFC 注册设备,NFC 记录必须包含 JSON 中属性的序列化 java.util.Properties 表示法。此字段是服务器生成的只读字段。

allowPersonalUsage

enum (AllowPersonalUsage)

控制是否允许在通过此注册令牌配置的设备上进行个人使用。

对于公司自有设备:

  • 启用个人用途后,用户可以在设备上设置工作资料。
  • 如需禁止个人使用,用户必须将设备配置为完全受管设备。

对于个人所有的设备:

  • 启用个人用途后,用户可以在设备上设置工作资料。
  • 停用个人用途会阻止设备进行配置。在个人拥有的设备上,无法停用个人用途。
defaultStatus

enum (SigninDetailDefaultStatus)

可选。是否应默认使用企业登录网址。将 SigninDetaildefaultStatus 设置为 SIGNIN_DETAIL_IS_DEFAULT 时,该 SigninDetail 会用作 Google 账号注册方法。企业的 signinDetails 中只能有一个将 defaultStatus 设置为 SIGNIN_DETAIL_IS_DEFAULT。如果 Enterprise 至少有一个 signinDetails,但没有一个 signinDetailsdefaultStatus 设置为 SIGNIN_DETAIL_IS_DEFAULT,则选择列表中的第一个 signinDetails,并将其 defaultStatus 设置为 SIGNIN_DETAIL_IS_DEFAULT。如果未为 Enterprise 指定 signinDetails,则 Google 账号设备注册将失败。

联合字段 _token_tag

_token_tag 只能是下列其中一项:

tokenTag

string

EMM 指定的元数据,用于区分 SigninDetail 的不同实例。

ContactInfo

JSON 表示法
{
  "contactEmail": string,
  "dataProtectionOfficerName": string,
  "dataProtectionOfficerEmail": string,
  "dataProtectionOfficerPhone": string,
  "euRepresentativeName": string,
  "euRepresentativeEmail": string,
  "euRepresentativePhone": string
}
字段
contactEmail

string

联系人的电子邮件地址,用于发送与受管理的 Google Play 相关的重要公告。

dataProtectionOfficerName

string

数据保护官的姓名。

dataProtectionOfficerEmail

string

数据保护官的电子邮件地址。电子邮件地址已通过验证,但未经验证。

dataProtectionOfficerPhone

string

数据保护官的电话号码。电话号码已通过验证,但未经过验证。

euRepresentativeName

string

欧盟代表的名称。

euRepresentativeEmail

string

欧盟代表的电子邮件地址。电子邮件地址已通过验证,但未经验证。

euRepresentativePhone

string

欧盟代表的电话号码。电话号码已通过验证,但尚未经过验证。

GoogleAuthenticationSettings

JSON 表示法
{
  "googleAuthenticationRequired": enum (GoogleAuthenticationRequired)
}
字段
googleAuthenticationRequired

enum (GoogleAuthenticationRequired)

仅限输出。在注册过程中,用户是否需要通过 Google 进行身份验证。IT 管理员可以指定是否为知识工作者设备的企业启用 Google 身份验证。此值只能通过 Google 管理控制台进行设置。Google 身份验证可与 signin_url 搭配使用。如果需要 Google 身份验证,并且指定了 signin_url,则系统会在启动 signin_url 之前启动 Google 身份验证。

工具注释

破坏性提示:❌ | 等幂性提示:✅ | 只读提示:✅ | 开放世界提示:❌