MCP Tools Reference: Android Device Management MCP Server

כלי: list_enterprises

רשימה של ארגונים שהמתקשר יכול לגשת אליהם.

בדוגמה הבאה אפשר לראות איך משתמשים ב-curl כדי להפעיל את כלי ה-MCP‏ list_enterprises.

בקשת סריקה
                  
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

חובה. מזהה הפרויקט ב-Cloud של מערכת ה-EMM שמנהלת את הארגונים.

pageSize

integer

גודל הדף המבוקש. גודל הדף בפועל עשוי להיות קבוע לערך מינימלי או מקסימלי.

pageToken

string

אסימון שמזהה דף תוצאות שהוחזר על ידי השרת.

view

enum (EnterpriseView)

מציין אילו שדות ארגוניים להחזיר. השיטה הזו תומכת רק ב-BASIC.

סכימת הפלט

תשובה לבקשה להוספת ארגונים לרשימה.

ListEnterprisesResponse

ייצוג ב-JSON
{
  "enterprises": [
    {
      object (Enterprise)
    }
  ],
  "nextPageToken": string
}
שדות
enterprises[]

object (Enterprise)

רשימת הארגונים.

nextPageToken

string

אם יש עוד תוצאות, יוחזר אסימון לאחזור הדף הבא של התוצאות.

Enterprise

ייצוג ב-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

כתובת ה-URL המוחלטת לנתונים, שחייבת להשתמש בסכימה http או https. האפליקציה Android Device Policy לא מספקת פרטי כניסה בבקשת ה-GET, ולכן כתובת ה-URL צריכה להיות זמינה לכולם. הוספה של רכיב ארוך ואקראי לכתובת ה-URL עשויה למנוע מהתוקפים לגלות את כתובת ה-URL.

sha256Hash

string

גיבוב SHA-256 של התוכן שמתארח בכתובת ה-URL, בקידוד Base64. אם התוכן לא תואם לגיבוב הזה, אפליקציית 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)

מפה שמכילה זוגות של <locale, message>, כאשר locale הוא קוד שפה בתקן 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

כתובת URL לכניסה לצורך אימות כשהמכשיר מוקצה עם טוקן הרשמה לכניסה. נקודת הקצה של הכניסה צריכה לסיים את תהליך האימות עם כתובת URL בפורמט https://enterprise.google.com/android/enroll?et= לכניסה מוצלחת, או https://enterprise.google.com/android/enroll/invalid לכניסה שנכשלה.

signinEnrollmentToken

string

אסימון רישום ברמת הארגון שמשמש להפעלת תהליך כניסה בהתאמה אישית. זהו שדה לקריאה בלבד שנוצר על ידי השרת.

qrCode

string

מחרוזת JSON שניתן להשתמש בייצוג שלה ב-UTF-8 כדי ליצור קוד QR לרישום מכשיר באמצעות טוקן הרישום הזה. כדי לרשום מכשיר באמצעות NFC, רשומת ה-NFC צריכה להכיל ייצוג של המאפיינים ב-JSON שעבר סריאליזציה java.util.Properties. זהו שדה לקריאה בלבד שנוצר על ידי השרת.

allowPersonalUsage

enum (AllowPersonalUsage)

המדיניות קובעת אם מותר להשתמש במכשיר לשימוש אישי אם הוא הוקצה באמצעות טוקן ההרשמה הזה.

למכשירים בבעלות החברה:

  • הפעלת השימוש האישי מאפשרת למשתמש להגדיר פרופיל עבודה במכשיר.
  • כדי להשבית את השימוש האישי, המשתמש צריך להקצות את המכשיר כמכשיר מנוהל באופן מלא.

במכשירים בבעלות אישית:

  • הפעלת השימוש האישי מאפשרת למשתמש להגדיר פרופיל עבודה במכשיר.
  • השבתת השימוש האישי תמנע את הקצאת המכשיר. אי אפשר להשבית שימוש אישי במכשיר בבעלות אישית.
defaultStatus

enum (SigninDetailDefaultStatus)

אופציונלי. האם כתובת ה-URL לכניסה צריכה לשמש כברירת מחדל לארגון. ההגדרה SigninDetail עם הערך defaultStatus שמוגדר ל-SIGNIN_DETAIL_IS_DEFAULT משמשת לשיטת ההרשמה לחשבון Google. רק לאחד מתוך signinDetails של ארגון יכול להיות הערך defaultStatus שמוגדר כ-SIGNIN_DETAIL_IS_DEFAULT. אם לפריט Enterprise יש לפחות מאפיין signinDetails אחד ואף אחד מהם לא מוגדר עם הערך defaultStatus ששווה ל-SIGNIN_DETAIL_IS_DEFAULT, המאפיין הראשון מהרשימה נבחר והערך defaultStatus שלו מוגדר ל-SIGNIN_DETAIL_IS_DEFAULT. אם לא מציינים signinDetails עבור Enterprise, ההרשמה של המכשיר לחשבון 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 Admin. אפשר להשתמש באימות של Google עם signin_url במקרה שנדרש אימות של Google וצוין signin_url, האימות של Google יופעל לפני signin_url.

הערות על כלי

רמז הרסני: ❌ | רמז אידמפוטנטי: ✅ | רמז לקריאה בלבד: ✅ | רמז לעולם פתוח: ❌