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)

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

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

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

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

user
(deprecated)

object (User)

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

allowPersonalUsage

enum (AllowPersonalUsage)

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

สำหรับอุปกรณ์ของบริษัท

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

สำหรับอุปกรณ์ที่ใช้ส่วนตัว

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

วิธีการ

create

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

delete

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

get

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

list

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