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}

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 ให้ไว้

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 ขององค์กรเพียง 1 แห่งเท่านั้นที่ตั้งค่า 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

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

เมธอด

create

สร้างองค์กร

delete

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

get

รับองค์กร

list

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

patch

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