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

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 ที่เข้ารหัสฐาน 64 ของเนื้อหาที่โฮสต์ใน URL หากเนื้อหาไม่ตรงกับแฮชนี้ 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ได้เพียงรายการเดียว หาก 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

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

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

get

รับองค์กร

list

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

patch

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