REST Resource: enterprises.enrollmentTokens

ทรัพยากร: EnrollmentToken

โทเค็นการลงทะเบียน

การแสดง JSON 
{
  "name": string,
  "value": string,
  "duration": string,
  "expirationTimestamp": string,
  "policyName": string,
  "additionalData": string,
  "qrCode": string,
  "oneTimeOnly": boolean,
  "user": {
    object (User)
  },
  "allowPersonalUsage": enum (AllowPersonalUsage)
}
ช่อง
name

string

ชื่อของโทเค็นการลงทะเบียนซึ่งเซิร์ฟเวอร์สร้างขึ้นในระหว่างการสร้างในรูปแบบ enterprises/{enterpriseId}/enrollmentTokens/{enrollmentTokenId}
value

string

ค่าโทเค็นที่ส่งไปยังอุปกรณ์และอนุญาตให้อุปกรณ์ลงทะเบียน ฟิลด์นี้เป็นฟิลด์แบบอ่านอย่างเดียวที่เซิร์ฟเวอร์สร้างขึ้น
duration

string (Duration format)

ระยะเวลาที่โทเค็นการลงทะเบียนใช้งานได้ ซึ่งอยู่ในช่วง 1 นาทีถึง Durations.MAX_VALUE หรือประมาณ 10,000 ปี หากไม่ได้ระบุไว้ ระยะเวลาเริ่มต้นจะเป็น 1 ชั่วโมง โปรดทราบว่าหากระยะเวลาที่ขอทําให้ expirationTimestamp ที่ได้ผลลัพธ์เกิน Timestamps.MAX_VALUE ระบบจะบังคับให้ expirationTimestamp เป็น Timestamps.MAX_VALUE

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย s เช่น "3.5s"
expirationTimestamp

string (Timestamp format)

เวลาหมดอายุของโทเค็น ฟิลด์นี้เป็นฟิลด์แบบอ่านอย่างเดียวที่เซิร์ฟเวอร์สร้างขึ้น

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตอื่นๆ นอกเหนือจาก "Z" ด้วย ตัวอย่างเช่น "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" หรือ "2014-10-02T15:01:23+05:30"
policyName

string

ชื่อนโยบายที่มีผลกับอุปกรณ์ที่ลงทะเบียนในตอนแรกในรูปแบบ enterprises/{enterpriseId}/policies/{policyId} หากไม่ได้ระบุ ระบบจะใช้ policyName ของผู้ใช้อุปกรณ์ หากไม่ได้ระบุ userName ด้วย ระบบจะใช้ enterprises/{enterpriseId}/policies/default เป็นค่าเริ่มต้น เมื่ออัปเดตช่องนี้ คุณจะระบุได้เฉพาะ policyId ตราบใดที่ policyId นั้นไม่มีเครื่องหมายทับ ระบบจะอนุมานชื่อนโยบายที่เหลือ
additionalData

string

ข้อมูลที่ไม่บังคับซึ่งเชื่อมโยงกับโทเค็นการลงทะเบียน ตัวอย่างเช่น อาจมีรหัสของหน่วยขององค์กรที่กำหนดให้กับอุปกรณ์หลังจากลงทะเบียน หลังจากอุปกรณ์ลงทะเบียนด้วยโทเค็นแล้ว ข้อมูลนี้จะแสดงในช่อง enrollmentTokenData ของทรัพยากร Device ข้อมูลต้องมีความยาวไม่เกิน 1, 024 อักขระ มิฉะนั้นคําขอสร้างจะดำเนินการไม่สำเร็จ
qrCode

string

สตริง JSON ที่ใช้การนำเสนอ UTF-8 เพื่อสร้างคิวอาร์โค้ดเพื่อลงทะเบียนอุปกรณ์ด้วยโทเค็นการลงทะเบียนนี้ หากต้องการลงทะเบียนอุปกรณ์โดยใช้ NFC ระเบียน NFC ต้องมีการแสดงผล java.util.Properties ที่แปลงเป็นอนุกรมของพร็อพเพอร์ตี้ใน JSON
oneTimeOnly

boolean

โทเค็นการลงทะเบียนใช้ได้เพียงครั้งเดียวเท่านั้น หากตั้งค่า Flag เป็น "จริง" จะมีเพียงอุปกรณ์เดียวเท่านั้นที่ใช้ Flag ดังกล่าวในการลงทะเบียนได้
user
(deprecated)

object (User)

ฟิลด์นี้เลิกใช้งานแล้วและระบบจะไม่สนใจค่า
allowPersonalUsage

enum (AllowPersonalUsage)

ควบคุมว่าจะอนุญาตให้ใช้งานส่วนตัวในอุปกรณ์ที่จัดสรรด้วยโทเค็นการลงทะเบียนนี้หรือไม่

สำหรับอุปกรณ์ของบริษัท ให้ทำดังนี้

  • การเปิดใช้การใช้งานส่วนตัวช่วยให้ผู้ใช้ตั้งค่าโปรไฟล์งานในอุปกรณ์ได้
  • การปิดใช้การใช้งานส่วนตัวกำหนดให้ผู้ใช้จัดสรรอุปกรณ์เป็นอุปกรณ์ที่มีการจัดการครบวงจร

สำหรับอุปกรณ์ส่วนตัว

  • การเปิดใช้การใช้งานส่วนตัวช่วยให้ผู้ใช้ตั้งค่าโปรไฟล์งานในอุปกรณ์ได้
  • การปิดใช้การใช้งานส่วนบุคคลจะป้องกันไม่ให้อุปกรณ์จัดสรร ปิดใช้การใช้งานส่วนตัวในอุปกรณ์ส่วนบุคคลไม่ได้

เมธอด

create

 สร้างโทเค็นการลงทะเบียนสําหรับองค์กรหนึ่งๆ

delete

 ลบโทเค็นการลงทะเบียน

get

 รับโทเค็นการลงทะเบียนที่ใช้งานอยู่และยังไม่หมดอายุ

list

 แสดงรายการโทเค็นการลงทะเบียนที่ใช้งานอยู่และยังไม่หมดอายุขององค์กรหนึ่งๆ