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)

معلومات الاتصال بالمؤسسة التي تديرها "إدارة الخدمات الجوّالة للمؤسسات"

googleAuthenticationSettings

object (GoogleAuthenticationSettings)

إعدادات مصادقة المستخدم التي توفّرها Google

enterpriseType

enum (EnterpriseType)

النتائج فقط. تمثّل هذه السمة نوع المؤسسة.

managedGooglePlayAccountsEnterpriseType

enum (ManagedGooglePlayAccountsEnterpriseType)

النتائج فقط. نوع "حسابات Google Play للأعمال"

managedGoogleDomainType

enum (ManagedGoogleDomainType)

النتائج فقط. نوع نطاق Google الخاضع للإدارة

NotificationType

أنواع الإشعارات التي قد يرسلها خادم إدارة الأجهزة عبر Google Pub/Sub

عمليات التعداد
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 لمنع المهاجمين من اكتشافه.

sha256Hash

string

تجزئة SHA-256 بترميز base-64 للمحتوى المستضاف على عنوان URL إذا لم يتطابق المحتوى مع قيمة التجزئة هذه، لن يستخدم تطبيق "سياسة Android للأجهزة" البيانات.

TermsAndConditions

صفحة الأحكام والشروط التي يجب قبولها أثناء عملية التوفير

تمثيل JSON
{
  "header": {
    object (UserFacingMessage)
  },
  "content": {
    object (UserFacingMessage)
  }
}
الحقول
header

object (UserFacingMessage)

عنوان قصير يظهر فوق محتوى HTML

content

object (UserFacingMessage)

سلسلة HTML منسَّقة بشكلٍ سليم سيتم تحليلها على العميل باستخدام android.text.Html#fromHtml.

SigninDetail

مرجع يحتوي على تفاصيل تسجيل الدخول إلى حساب مؤسسة استخدِم enterprises لإدارة SigninDetail لمؤسسة معيّنة.

بالنسبة إلى المؤسسة، يمكن أن يكون لدينا أي عدد من SigninDetail يتم تحديده بشكل فريد من خلال مجموعة من الحقول الثلاثة التالية (signinUrl وallowPersonalUsage وtokenTag). لا يمكن إنشاء SigninDetailَين لهما نفس (signinUrl وallowPersonalUsage وtokenTag). (tokenTag هو حقل اختياري).

Patch: تعدّل العملية قائمة SigninDetails الحالية بقائمة SigninDetails الجديدة.

  • في حال اجتياز إعدادات SigninDetail المخزَّنة، يتم عرض signinEnrollmentToken وqrCode نفسيهما.
  • إذا مرّرنا إعدادات SigninDetail متطابقة متعددة غير مخزّنة، سيتم تخزين الإعداد الأول من بين إعدادات SigninDetail هذه.
  • إذا كان الإعداد متوفّرًا، لا يمكننا طلبه أكثر من مرة في طلب بيانات من واجهة برمجة التطبيقات لتعديل جزء من البيانات، وإلا سيظهر خطأ في المفتاح المكرّر وستفشل العملية بأكملها.
  • إذا أزلنا إعدادات 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 لإنشاء رمز استجابة سريعة لتسجيل جهاز باستخدام رمز التسجيل المميز هذا. لتسجيل جهاز باستخدام NFC، يجب أن يتضمّن سجل NFC تمثيلاً java.util.Properties متسلسلاً للسمات في JSON. هذا الحقل للقراءة فقط وينشئه الخادم.

allowPersonalUsage

enum (AllowPersonalUsage)

تتحكّم هذه السياسة في ما إذا كان مسموحًا بالاستخدام الشخصي على جهاز تم توفير إمكانية استخدامه باستخدام رمز التسجيل هذا.

بالنسبة إلى الأجهزة المملوكة للشركة:

  • تتيح إمكانية الاستخدام الشخصي للمستخدم إعداد ملف عمل على الجهاز.
  • يتطلّب إيقاف الاستخدام الشخصي أن يوفّر المستخدم الجهاز كجهاز مُدار بالكامل.

بالنسبة إلى الأجهزة الشخصية:

  • تتيح إمكانية الاستخدام الشخصي للمستخدم إعداد ملف عمل على الجهاز.
  • سيؤدي إيقاف الاستخدام الشخصي إلى منع الجهاز من توفير الموارد. لا يمكن إيقاف الاستخدام الشخصي على جهاز مملوك شخصيًا.
defaultStatus

enum (SigninDetailDefaultStatus)

اختيارية: تحديد ما إذا كان يجب استخدام عنوان URL لتسجيل الدخول تلقائيًا للمؤسسة يتم استخدام SigninDetail مع ضبط defaultStatus على SIGNIN_DETAIL_IS_DEFAULT كطريقة لتسجيل حساب Google. يمكن أن يكون signinDetails واحد فقط من signinDetails في المؤسسة مضبوطًا على defaultStatus بقيمة SIGNIN_DETAIL_IS_DEFAULT. إذا كان Enterprise يتضمّن signinDetails واحدًا على الأقل ولم يتم ضبط أي منها على defaultStatus بقيمة SIGNIN_DETAIL_IS_DEFAULT، يتم اختيار العنصر الأول من القائمة ويتم ضبط defaultStatus على SIGNIN_DETAIL_IS_DEFAULT. في حال عدم تحديد signinDetails لـ Enterprise، سيتعذّر تسجيل الجهاز في حساب Google.

tokenTag

string

بيانات وصفية تحدّدها إدارة الخدمات الجوّالة للمؤسسات (EMM) للتمييز بين مثيلات SigninDetail.

SigninDetailDefaultStatus

تحديد ما إذا كان يجب استخدام عنوان URL لتسجيل الدخول تلقائيًا للمؤسسة

عمليات التعداد
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 أثناء عملية التسجيل. يمكن لمشرف تكنولوجيا المعلومات تحديد ما إذا كانت ميزة "المصادقة باستخدام Google" مفعّلة للمؤسسة على أجهزة الموظفين الذين يستند عملهم إلى المعرفة المكتسبة. لا يمكن ضبط هذه القيمة إلا من خلال "وحدة تحكّم المشرف" في Google. يمكن استخدام مصادقة Google مع signinUrl في حال كانت مصادقة Google مطلوبة وتم تحديد signinUrl، سيتم تشغيل مصادقة Google قبل signinUrl.

GoogleAuthenticationRequired

إعداد يحدّد ما إذا كانت مصادقة Google مطلوبة لهذه المؤسسة.

عمليات التعداد
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED لا يتم استخدام هذه القيمة.
NOT_REQUIRED لا يلزم إجراء مصادقة Google.
REQUIRED يجب أن تتم مصادقة المستخدم بنجاح من خلال Google.

EnterpriseType

تمثّل هذه السمة نوع المؤسسة.

عمليات التعداد
ENTERPRISE_TYPE_UNSPECIFIED لا يتم استخدام هذه القيمة.
MANAGED_GOOGLE_DOMAIN تنتمي المؤسسة إلى نطاق Google خاضع للإدارة.
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE المؤسسة هي حسابات Google Play للأعمال.

ManagedGooglePlayAccountsEnterpriseType

نوع "حسابات Google Play للأعمال"

عمليات التعداد
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE_TYPE_UNSPECIFIED لم يتم تحديد نوع "حسابات Google Play للأعمال".
CUSTOMER_MANAGED تتولّى المؤسسة إدارة حسابها
EMM_MANAGED المؤسسة مُدارة من خلال "إدارة الخدمات الجوّالة للمؤسسات" (تم إيقافها نهائيًا).

ManagedGoogleDomainType

نوع نطاق Google الخاضع للإدارة

عمليات التعداد
MANAGED_GOOGLE_DOMAIN_TYPE_UNSPECIFIED لم يتم تحديد نوع نطاق Google المُدار.
TYPE_TEAM نطاق Google المُدار هو فريق تم إثبات ملكية عنوان بريده الإلكتروني.
TYPE_DOMAIN تم إثبات ملكية نطاق Google المُدار.

الطُرق

create

تُنشئ هذه الطريقة مؤسسة.

delete

لحذف مؤسسة وجميع الحسابات والبيانات المرتبطة بها نهائيًا

generateEnterpriseUpgradeUrl

تنشئ هذه الطريقة عنوان URL لترقية المؤسسة من أجل ترقية مؤسسة "حسابات Google Play للأعمال" الحالية إلى نطاق Google خاضع للإدارة.

get

الحصول على مؤسسة

list

تعرض هذه الطريقة قائمة بالمؤسسات التي تتم إدارتها من خلال إدارة الخدمات الجوّالة للمؤسسات (EMM).

patch

تعديل مؤسسة