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 ที่ระบุสีหลักที่จะแสดงใน UI ของแอปการจัดการอุปกรณ์ ระบบจะจัดเก็บคอมโพเนนต์สีดังนี้ (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)

เอาต์พุตเท่านั้น ประเภทของกลุ่มบัญชี Managed 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 การอัปเกรดองค์กรคือกระบวนการที่อัปเกรดกลุ่มบัญชี Managed Google Play สำหรับองค์กรเป็นโดเมน Google ที่มีการจัดการ

ExternalData

ข้อมูลที่โฮสต์ในสถานที่ภายนอก Android Device Policy จะดาวน์โหลดข้อมูลและยืนยันกับแฮช

การแสดง JSON
{
  "url": string,
  "sha256Hash": string
}
ช่อง
url

string

URL ที่สมบูรณ์ของข้อมูล ซึ่งต้องใช้ Scheme http หรือ https Device Policy ของ Android ไม่ได้ระบุข้อมูลเข้าสู่ระบบใดๆ ในคำขอ 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 สำหรับองค์กรที่ต้องการ

สำหรับองค์กร เราสามารถมี SigninDetail ได้ไม่จำกัดจำนวน ซึ่งระบุได้อย่างไม่ซ้ำกันด้วยการรวมฟิลด์ 3 รายการต่อไปนี้ (signinUrl, allowPersonalUsage, tokenTag) โดยไม่สามารถสร้าง SigninDetail 2 รายการที่มี (signinUrl, allowPersonalUsage, tokenTag) เดียวกันได้ (tokenTag เป็นฟิลด์ที่ไม่บังคับ)

Patch: การดำเนินการจะอัปเดตรายการ SigninDetails ปัจจุบันด้วยรายการ SigninDetails ใหม่

  • หากส่งSigninDetailที่จัดเก็บไว้ ระบบจะแสดงsigninEnrollmentTokenและqrCodeเดียวกัน
  • หากเราส่งSigninDetailการกำหนดค่าที่เหมือนกันหลายรายการซึ่งไม่ได้จัดเก็บไว้ ระบบจะจัดเก็บSigninDetailการกำหนดค่ารายการแรกในบรรดาการกำหนดค่าเหล่านั้น
  • หากมีการกำหนดค่าอยู่แล้ว เราจะขอการกำหนดค่าดังกล่าวมากกว่า 1 ครั้งในการเรียกใช้ 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 เพื่อสร้างคิวอาร์โค้ดเพื่อลงทะเบียนอุปกรณ์ด้วยโทเค็นการลงทะเบียนนี้ได้ หากต้องการลงทะเบียนอุปกรณ์โดยใช้ 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 ได้เพียง 1 รายการ หาก Enterprise มี signinDetails อย่างน้อย 1 รายการและไม่มีรายการใดตั้งค่า 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

ข้อมูลติดต่อสำหรับองค์กรที่ใช้ Managed Google Play

การแสดง JSON
{
  "contactEmail": string,
  "dataProtectionOfficerName": string,
  "dataProtectionOfficerEmail": string,
  "dataProtectionOfficerPhone": string,
  "euRepresentativeName": string,
  "euRepresentativeEmail": string,
  "euRepresentativePhone": string
}
ช่อง
contactEmail

string

อีเมลสำหรับผู้ติดต่อ ซึ่งจะใช้เพื่อส่งประกาศสำคัญที่เกี่ยวข้องกับ Managed 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 สำหรับองค์กรนี้หรือไม่

Enum
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED ระบบจะไม่ใช้ค่านี้
NOT_REQUIRED ไม่จำเป็นต้องมีการตรวจสอบสิทธิ์ของ Google
REQUIRED ผู้ใช้จะต้องได้รับการตรวจสอบสิทธิ์จาก Google เรียบร้อยแล้ว

EnterpriseType

ประเภทขององค์กร

Enum
ENTERPRISE_TYPE_UNSPECIFIED ระบบจะไม่ใช้ค่านี้
MANAGED_GOOGLE_DOMAIN องค์กรเป็นของโดเมน Google ที่มีการจัดการ
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE องค์กรเป็นกลุ่มบัญชี Managed Google Play สำหรับองค์กร

ManagedGooglePlayAccountsEnterpriseType

ประเภทของกลุ่มบัญชี Managed Google Play สำหรับองค์กร

Enum
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทกลุ่มบัญชี Managed Google Play สำหรับองค์กร
CUSTOMER_MANAGED องค์กรได้รับการจัดการโดยลูกค้า
EMM_MANAGED องค์กรมีการจัดการ EMM (เลิกใช้งานแล้ว)

ManagedGoogleDomainType

ประเภทของโดเมน Google ที่มีการจัดการ

Enum
MANAGED_GOOGLE_DOMAIN_TYPE_UNSPECIFIED ไม่ได้ระบุประเภทโดเมน Google ที่มีการจัดการ
TYPE_TEAM โดเมน Google ที่มีการจัดการเป็นทีมที่ยืนยันด้วยอีเมล
TYPE_DOMAIN โดเมน Google ที่มีการจัดการได้รับการยืนยันด้วยโดเมนแล้ว

เมธอด

create

สร้างองค์กร

delete

ลบองค์กรและบัญชีและข้อมูลทั้งหมดที่เชื่อมโยงกับองค์กรอย่างถาวร

generateEnterpriseUpgradeUrl

สร้าง URL การอัปเกรดองค์กรเพื่ออัปเกรดกลุ่มบัญชี Managed Google Play สำหรับองค์กรที่มีอยู่เป็นโดเมน Google ที่มีการจัดการ

get

รับองค์กร

list

แสดงรายการองค์กรที่จัดการโดย EMM

patch

อัปเดตองค์กร