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.

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 בקידוד base64 של התוכן שמתארח בכתובת ה-URL. אם התוכן לא תואם ל-hash הזה, המערכת של 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 חייבת להכיל ייצוג java.util.Properties בסריאליזציה של המאפיינים ב-JSON. זהו שדה לקריאה בלבד שנוצר על ידי השרת.

allowPersonalUsage

enum (AllowPersonalUsage)

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

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

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

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

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

enum (SigninDetailDefaultStatus)

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

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

get

אחזור של ארגון.

list

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

patch

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