REST Resource: enterprises

משאב: 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, כולל.
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.

NotificationType

סוגי ההתראות ששרת ניהול המכשירים עשוי לשלוח באמצעות Google Pub/Sub.

טיפוסים בני מנייה (enum)
NOTIFICATION_TYPE_UNSPECIFIED המערכת מתעלמת מהערך הזה.
ENROLLMENT התראה שנשלחת כשמכשיר נרשם.
COMPLIANCE_REPORT

הוצא משימוש.
STATUS_REPORT התראה שנשלחת כשמכשיר מפיק דוח סטטוס.
COMMAND התראה שנשלחת כשפקודה למכשיר מסתיימת.
USAGE_LOGS התראה שנשלחת כשהמכשיר שולח BatchUsageLogEvents.
ENTERPRISE_UPGRADE התראה שנשלחת לשדרוג ל-Enterprise. שדרוג לארגון הוא תהליך שבו משדרגים קבוצת חשבונות של Google Play לארגונים לדומיין מנוהל ב-Google.

ExternalData

נתונים שמתארחים במיקום חיצוני. הנתונים מיועדים להורדה על ידי Android Device Policy ולאימות מול הגיבוב.

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

SigninDetail

משאב שמכיל פרטי כניסה לארגון. אפשר להשתמש ב-enterprises כדי לנהל SigninDetail של ארגון מסוים.

בארגון יכולים להיות מספר כלשהו של SigninDetails שמזוהים באופן ייחודי על ידי שילוב של שלושת השדות הבאים (signinUrl,‏ allowPersonalUsage,‏ tokenTag). אי אפשר ליצור שני SigninDetails עם אותו שילוב של (signinUrl,‏ allowPersonalUsage,‏ tokenTag). (tokenTag הוא שדה אופציונלי).

‫Patch: הפעולה מעדכנת את הרשימה הנוכחית של SigninDetails ברשימה החדשה של SigninDetails.

  • אם מועברת ההגדרה המאוחסנת SigninDetail, הפונקציה מחזירה את אותם ערכים של signinEnrollmentToken ו-qrCode.
  • אם נעביר כמה הגדרות זהות של SigninDetail שלא נשמרו, המערכת תשמור את הראשונה מביניהן.SigninDetail
  • אם ההגדרה כבר קיימת, אי אפשר לבקש אותה יותר מפעם אחת בקריאה מסוימת ל-API של תיקון, אחרת תוצג שגיאת מפתח כפול והפעולה כולה תיכשל.
  • אם נסיר הגדרה מסוימת מהבקשה, היא תוסר מהאחסון.SigninDetail לאחר מכן נוכל לבקש עוד signinEnrollmentToken וqrCode לאותה הגדרה של SigninDetail.
ייצוג ב-JSON 
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "defaultStatus": enum (SigninDetailDefaultStatus),
  "tokenTag": string
}
שדות
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 לכניסה צריכה לשמש כברירת מחדל לארגון. השיטה להרשמה לחשבון Google היא SigninDetail עם הערך defaultStatus שמוגדר ל-SIGNIN_DETAIL_IS_DEFAULT. רק לאחד מתוך signinDetails של ארגון יכול להיות הערך SIGNIN_DETAIL_IS_DEFAULT בשדה defaultStatus. אם לפריט Enterprise יש לפחות מאפיין signinDetails אחד ואף אחד מהם לא מוגדר עם defaultStatus שערכו SIGNIN_DETAIL_IS_DEFAULT, המאפיין הראשון מהרשימה נבחר וערך defaultStatus שלו מוגדר ל-SIGNIN_DETAIL_IS_DEFAULT. אם לא מציינים signinDetails עבור Enterprise, ההרשמה של המכשיר לחשבון Google תיכשל.
tokenTag

string

מטא-נתונים שצוינו על ידי EMM כדי להבחין בין מופעים של SigninDetail.

SigninDetailDefaultStatus

האם כתובת ה-URL לכניסה צריכה לשמש כברירת מחדל לארגון.

טיפוסים בני מנייה (enum)
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED שווה ערך ל-SIGNIN_DETAIL_IS_NOT_DEFAULT.
SIGNIN_DETAIL_IS_DEFAULT כתובת ה-URL לכניסה תשמש כברירת מחדל לארגון.
SIGNIN_DETAIL_IS_NOT_DEFAULT כתובת ה-URL לכניסה לא תשמש כברירת מחדל לארגון.

ContactInfo

פרטים ליצירת קשר עם קבוצות של חשבונות Google Play לארגונים.

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

כוללת הגדרות לאימות משתמשים שסופק על ידי Google.

ייצוג ב-JSON 
{
  "googleAuthenticationRequired": enum (GoogleAuthenticationRequired)
}
שדות
googleAuthenticationRequired

enum (GoogleAuthenticationRequired)

פלט בלבד. האם המשתמשים צריכים לעבור אימות על ידי Google במהלך תהליך ההרשמה. אדמינים ב-IT יכולים לציין אם האימות של Google מופעל בארגון למכשירים של עובדי ידע. אפשר להגדיר את הערך הזה רק דרך מסוף Google Admin. אפשר להשתמש באימות של Google עם signinUrl במקרה שנדרש אימות של Google וצוין signinUrl, האימות של Google יופעל לפני signinUrl.

GoogleAuthenticationRequired

הגדרה שקובעת אם נדרש אימות של Google לארגון הזה.

טיפוסים בני מנייה (enum)
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED הערך הזה לא נמצא בשימוש.
NOT_REQUIRED לא נדרש אימות של Google.
REQUIRED המשתמש נדרש לעבור אימות מוצלח על ידי Google.

EnterpriseType

סוג הארגון.

טיפוסים בני מנייה (enum)
ENTERPRISE_TYPE_UNSPECIFIED הערך הזה לא נמצא בשימוש.
MANAGED_GOOGLE_DOMAIN הארגון שייך לדומיין מנוהל של Google.
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE הארגון הוא קבוצת חשבונות Google Play לארגונים.

ManagedGooglePlayAccountsEnterpriseType

הסוג של קבוצת חשבונות Google Play לארגונים.

טיפוסים בני מנייה (enum)
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE_TYPE_UNSPECIFIED לא צוין סוג של קבוצת חשבונות Google Play לארגונים.
CUSTOMER_MANAGED הארגון מנוהל על ידי הלקוח
EMM_MANAGED הארגון מנוהל על ידי EMM (הוצא משימוש).

ManagedGoogleDomainType

סוג הדומיין המנוהל של Google.

טיפוסים בני מנייה (enum)
MANAGED_GOOGLE_DOMAIN_TYPE_UNSPECIFIED לא צוין סוג הדומיין המנוהל של Google.
TYPE_TEAM הדומיין המנוהל ב-Google הוא צוות שאומת באמצעות אימייל.
TYPE_DOMAIN הדומיין המנוהל של Google מאומת באמצעות דומיין.

Methods

create

 יצירת ארגון.

delete

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

generateEnterpriseUpgradeUrl

 יוצר כתובת URL לשדרוג הארגון, כדי לשדרג קבוצת חשבונות קיימת של Google Play לארגונים לדומיין מנוהל ב-Google.

get

 מקבלים ארגון.

list

 רשימה של ארגונים שמנוהלים על ידי EMM.

patch

 עדכון של ארגון.