REST Resource: enterprises

منبع: سازمانی

پیکربندی اعمال شده برای یک شرکت.

نمایندگی 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)
  }
}
فیلدها
name

string

نام شرکتی که در حین ایجاد توسط سرور تولید می‌شود، به شکل enterprises/{enterpriseId} .

enabled Notification Types[]

enum ( NotificationType )

انواع اعلان‌های Google Pub/Sub فعال شده برای شرکت.

pubsub Topic

string

موضوعی که اعلان‌های Pub/Sub به شکل projects/{project}/topics/{topic} برای آن منتشر می‌شوند. این فیلد فقط در صورتی لازم است که اعلان‌های Pub/Sub فعال باشند .

primary Color

integer

رنگی با فرمت RGB که نشان دهنده رنگ غالب برای نمایش در رابط کاربری برنامه مدیریت دستگاه است. اجزای رنگ به صورت زیر ذخیره می شوند: (red << 16) | (green << 8) | blue ، که در آن مقدار هر جزء بین 0 تا 255 است.

enterprise Display Name

string

نام شرکتی که به کاربران نمایش داده می شود. حداکثر طول این فیلد 100 کاراکتر است.

terms And Conditions[]

object ( TermsAndConditions )

شرایط و ضوابطی که باید هنگام تهیه دستگاه برای این شرکت پذیرفته شود. یک صفحه از اصطلاحات برای هر مقدار در این لیست ایجاد می شود.

appAutoApprovalEnabled
(deprecated)

boolean

منسوخ و استفاده نشده.

signin Details[]

object ( SigninDetail )

جزئیات ورود به سیستم شرکت

contact Info

object ( ContactInfo )

اطلاعات تماس سازمانی یک شرکت تحت مدیریت EMM.

google Authentication Settings

object ( GoogleAuthenticationSettings )

تنظیمات برای احراز هویت کاربر ارائه شده توسط Google.

نوع اعلان

انواع اعلان‌هایی که سرور مدیریت دستگاه ممکن است از طریق Google Pub/Sub ارسال کند.

Enums
NOTIFICATION_TYPE_UNSPECIFIED این مقدار نادیده گرفته می شود.
ENROLLMENT زمانی که دستگاهی ثبت نام می کند، اعلان ارسال می شود.
COMPLIANCE_REPORT

منسوخ شده است.

STATUS_REPORT هنگامی که دستگاهی گزارش وضعیت را صادر می کند، اعلان ارسال می شود.
COMMAND زمانی که فرمان دستگاه کامل شد، اعلان ارسال می‌شود.
USAGE_LOGS هنگامی که دستگاه BatchUsageLogEvents ارسال می کند، اعلان ارسال می شود.

داده های خارجی

داده های میزبانی شده در یک مکان خارجی داده‌ها باید توسط Android Device Policy دانلود شوند و در برابر هش تأیید شوند.

نمایندگی JSON 
{
  "url": string,
  "sha256Hash": string
}
فیلدها
url

string

URL مطلق به داده ها، که باید از طرح http یا https استفاده کند. خط‌مشی دستگاه Android هیچ اعتباری را در درخواست GET ارائه نمی‌کند، بنابراین URL باید برای عموم قابل دسترسی باشد. از جمله یک جزء طولانی و تصادفی در URL ممکن است برای جلوگیری از کشف URL توسط مهاجمان استفاده شود.

sha256 Hash

string

Bas-64 هش SHA-256 محتوای میزبانی شده در url را رمزگذاری کرد. اگر محتوا با این هش مطابقت نداشته باشد، خط‌مشی دستگاه Android از داده‌ها استفاده نخواهد کرد.

شرایط و ضوابط

صفحه شرایط و ضوابط که در حین تهیه پذیرفته می شود.

نمایندگی 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 ذخیره می‌شود.
  • اگر پیکربندی از قبل وجود داشته باشد، نمی‌توانیم آن را بیش از یک بار در یک تماس API پچ خاص درخواست کنیم، در غیر این صورت یک خطای کلید تکراری می‌دهد و کل عملیات با شکست مواجه می‌شود.
  • اگر پیکربندی SigninDetail خاصی را از درخواست حذف کنیم، از فضای ذخیره‌سازی حذف خواهد شد. سپس می توانیم signinEnrollmentToken و qrCode دیگری را برای همان پیکربندی SigninDetail درخواست کنیم.
نمایندگی JSON 
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "defaultStatus": enum (SigninDetailDefaultStatus),
  "tokenTag": string
}
فیلدها
signin Url

string

URL ورود به سیستم برای احراز هویت زمانی که دستگاه دارای کد ثبت نام ورود به سیستم است. نقطه پایانی ورود به سیستم باید جریان احراز هویت را با یک URL به شکل https://enterprise.google.com/android/enroll?et= به پایان برساند. برای ورود موفقیت آمیز، یا https://enterprise.google.com/android/enroll/invalid برای ورود ناموفق.

signin Enrollment Token

string

یک رمز ثبت نام گسترده سازمانی که برای راه اندازی جریان ورود به سیستم سفارشی استفاده می شود. این یک فیلد فقط خواندنی است که توسط سرور ایجاد شده است.

qr Code

string

یک رشته JSON که نمایش UTF-8 آن می تواند برای ایجاد یک کد QR برای ثبت دستگاه با این نشانه ثبت نام استفاده شود. برای ثبت نام دستگاهی با استفاده از NFC، رکورد NFC باید حاوی نمایش java.util.Properties در JSON باشد. این یک فیلد فقط خواندنی است که توسط سرور ایجاد شده است.

allow Personal Usage

enum ( AllowPersonalUsage )

کنترل می کند که آیا استفاده شخصی در دستگاهی که با این کد ثبت نام ارائه شده مجاز است یا خیر.

برای دستگاه های متعلق به شرکت:

  • فعال کردن استفاده شخصی به کاربر امکان می‌دهد یک نمایه کاری در دستگاه تنظیم کند.
  • غیرفعال کردن استفاده شخصی مستلزم ارائه دستگاه به عنوان یک دستگاه کاملاً مدیریت شده توسط کاربر است.

برای دستگاه های شخصی:

  • فعال کردن استفاده شخصی به کاربر امکان می‌دهد یک نمایه کاری در دستگاه تنظیم کند.
  • غیرفعال کردن استفاده شخصی از تامین دستگاه جلوگیری می کند. استفاده شخصی را نمی توان در دستگاه شخصی غیرفعال کرد.
default Status

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

string

یک ابرداده مشخص شده توسط EMM برای تمایز بین نمونه‌های SigninDetail .

SigninDetailDefaultStatus

آیا URL ورود به سیستم باید به طور پیش فرض برای شرکت استفاده شود یا خیر.

Enums
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED معادل SIGNIN_DETAIL_IS_NOT_DEFAULT .
SIGNIN_DETAIL_IS_DEFAULT URL ورود به سیستم به طور پیش فرض برای شرکت استفاده می شود.
SIGNIN_DETAIL_IS_NOT_DEFAULT URL ورود به سیستم به طور پیش فرض برای شرکت استفاده نمی شود.

اطلاعات تماس

جزئیات تماس برای شرکت های مدیریت شده Google Play.

نمایندگی JSON 
{
  "contactEmail": string,
  "dataProtectionOfficerName": string,
  "dataProtectionOfficerEmail": string,
  "dataProtectionOfficerPhone": string,
  "euRepresentativeName": string,
  "euRepresentativeEmail": string,
  "euRepresentativePhone": string
}
فیلدها
contact Email

string

آدرس ایمیل یک نقطه تماس، که برای ارسال اعلان‌های مهم مربوط به Google Play مدیریت‌شده استفاده می‌شود.

data Protection Officer Name

string

نام افسر حفاظت از داده ها.

data Protection Officer Email

string

ایمیل افسر حفاظت از داده ها. ایمیل تأیید شده است اما تأیید نشده است.

data Protection Officer Phone

string

شماره تلفن افسر حفاظت از داده ها شماره تلفن تأیید شده است اما تأیید نشده است.

eu Representative Name

string

نام نماینده اتحادیه اروپا

eu Representative Email

string

ایمیل نماینده اتحادیه اروپا ایمیل تأیید شده است اما تأیید نشده است.

eu Representative Phone

string

شماره تلفن نماینده اتحادیه اروپا شماره تلفن تأیید شده است اما تأیید نشده است.

GoogleAuthenticationSettings

شامل تنظیماتی برای احراز هویت کاربر ارائه شده توسط Google است.

نمایندگی JSON 
{
  "googleAuthenticationRequired": enum (GoogleAuthenticationRequired)
}
فیلدها
google Authentication Required

enum ( GoogleAuthenticationRequired )

فقط خروجی اینکه آیا کاربران در طول فرآیند ثبت نام باید توسط Google احراز هویت شوند یا خیر. سرپرست فناوری اطلاعات می‌تواند تعیین کند که آیا احراز هویت Google برای دستگاه‌های دانش‌آموز برای شرکت فعال است یا خیر. این مقدار را فقط می توان از طریق کنسول مدیریت گوگل تنظیم کرد. احراز هویت Google را می توان با signinUrl استفاده کرد در مواردی که احراز هویت Google مورد نیاز باشد و یک signinUrl مشخص شده باشد، احراز هویت Google قبل از signinUrl راه اندازی می شود.

Google Authentication Required

تنظیم برای اینکه آیا احراز هویت Google برای این شرکت مورد نیاز است یا خیر.

Enums
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED این مقدار استفاده نمی شود.
NOT_REQUIRED احراز هویت گوگل لازم نیست.
REQUIRED کاربر باید با موفقیت توسط Google احراز هویت شود.

روش ها

create

 یک شرکت ایجاد می کند.

delete

 یک شرکت و تمام حساب ها و داده های مرتبط با آن را برای همیشه حذف می کند.

get

 یک شرکت می گیرد.

list

 شرکت های تحت مدیریت EMM را فهرست می کند.

patch

 یک شرکت را به روز می کند.