Tool: get_enterprise
Gets an enterprise for a given enterprise ID. Requires the enterprise ID in the name field (e.g., enterprises/{enterpriseId}).
The following sample demonstrate how to use curl to invoke the get_enterprise MCP tool.
| Curl Request |
|---|
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": "get_enterprise", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }' |
Input Schema
Request to get an enterprise. Returns all available fields.
GetEnterpriseRequest
| JSON representation |
|---|
{ "name": string } |
| Fields | |
|---|---|
name |
The name of the enterprise in the form |
Output Schema
The configuration applied to an enterprise.
Enterprise
| JSON representation |
|---|
{ "name": string, "enabledNotificationTypes": [ enum ( |
| Fields | |
|---|---|
name |
The name of the enterprise which is generated by the server during creation, in the form |
enabledNotificationTypes[] |
The types of Google Pub/Sub notifications enabled for the enterprise. |
pubsubTopic |
The topic which Pub/Sub notifications are published to, in the form |
primaryColor |
A color in RGB format that indicates the predominant color to display in the device management app UI. The color components are stored as follows: |
logo |
An image displayed as a logo during device provisioning. Supported types are: image/bmp, image/gif, image/x-ico, image/jpeg, image/png, image/webp, image/vnd.wap.wbmp, image/x-adobe-dng. |
enterpriseDisplayName |
The name of the enterprise displayed to users. This field has a maximum length of 100 characters. |
termsAndConditions[] |
Terms and conditions that must be accepted when provisioning a device for this enterprise. A page of terms is generated for each value in this list. |
appAutoApprovalEnabled |
Deprecated and unused. |
signinDetails[] |
Sign-in details of the enterprise. |
contactInfo |
The enterprise contact info of an EMM-managed enterprise. |
googleAuthenticationSettings |
Settings for Google-provided user authentication. |
enterpriseType |
Output only. The type of the enterprise. |
managedGooglePlayAccountsEnterpriseType |
Output only. The type of a managed Google Play Accounts enterprise. |
managedGoogleDomainType |
Output only. The type of managed Google domain. |
Int32Value
| JSON representation |
|---|
{ "value": integer } |
| Fields | |
|---|---|
value |
The int32 value. |
ExternalData
| JSON representation |
|---|
{ "url": string, "sha256Hash": string } |
| Fields | |
|---|---|
url |
The absolute URL to the data, which must use either the http or https scheme. Android Device Policy doesn't provide any credentials in the GET request, so the URL must be publicly accessible. Including a long, random component in the URL may be used to prevent attackers from discovering the URL. |
sha256Hash |
The base-64 encoded SHA-256 hash of the content hosted at url. If the content doesn't match this hash, Android Device Policy won't use the data. |
TermsAndConditions
| JSON representation |
|---|
{ "header": { object ( |
| Fields | |
|---|---|
header |
A short header which appears above the HTML content. |
content |
A well-formatted HTML string. It will be parsed on the client with android.text.Html#fromHtml. |
UserFacingMessage
| JSON representation |
|---|
{ "localizedMessages": { string: string, ... }, "defaultMessage": string } |
| Fields | |
|---|---|
localizedMessages |
A map containing <locale, message> pairs, where locale is a well-formed BCP 47 language code, such as en-US, es-ES, or fr. An object containing a list of |
defaultMessage |
The default message displayed if no localized message is specified or the user's locale doesn't match with any of the localized messages. A default message must be provided if any localized messages are provided. |
LocalizedMessagesEntry
| JSON representation |
|---|
{ "key": string, "value": string } |
| Fields | |
|---|---|
key |
|
value |
|
SigninDetail
| JSON representation |
|---|
{ "signinUrl": string, "signinEnrollmentToken": string, "qrCode": string, "allowPersonalUsage": enum ( |
| Fields | |
|---|---|
signinUrl |
Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= |
signinEnrollmentToken |
An enterprise wide enrollment token used to trigger custom sign-in flow. This is a read-only field generated by the server. |
qrCode |
A JSON string whose UTF-8 representation can be used to generate a QR code to enroll a device with this enrollment token. To enroll a device using NFC, the NFC record must contain a serialized |
allowPersonalUsage |
Controls whether personal usage is allowed on a device provisioned with this enrollment token. For company-owned devices:
For personally-owned devices:
|
defaultStatus |
Optional. Whether the sign-in URL should be used by default for the enterprise. The |
Union field
|
|
tokenTag |
An EMM-specified metadata to distinguish between instances of |
ContactInfo
| JSON representation |
|---|
{ "contactEmail": string, "dataProtectionOfficerName": string, "dataProtectionOfficerEmail": string, "dataProtectionOfficerPhone": string, "euRepresentativeName": string, "euRepresentativeEmail": string, "euRepresentativePhone": string } |
| Fields | |
|---|---|
contactEmail |
Email address for a point of contact, which will be used to send important announcements related to managed Google Play. |
dataProtectionOfficerName |
The name of the data protection officer. |
dataProtectionOfficerEmail |
The email of the data protection officer. The email is validated but not verified. |
dataProtectionOfficerPhone |
The phone number of the data protection officer The phone number is validated but not verified. |
euRepresentativeName |
The name of the EU representative. |
euRepresentativeEmail |
The email of the EU representative. The email is validated but not verified. |
euRepresentativePhone |
The phone number of the EU representative. The phone number is validated but not verified. |
GoogleAuthenticationSettings
| JSON representation |
|---|
{
"googleAuthenticationRequired": enum ( |
| Fields | |
|---|---|
googleAuthenticationRequired |
Output only. Whether users need to be authenticated by Google during the enrollment process. IT admin can specify if Google authentication is enabled for the enterprise for knowledge worker devices. This value can be set only via the Google Admin Console. Google authentication can be used with |
Tool Annotations
Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌