แหล่งข้อมูล: ผู้ใช้
Directory API ช่วยให้คุณสร้างและจัดการผู้ใช้ของบัญชี ชื่อแทนผู้ใช้ และรูปโปรไฟล์ Google ของผู้ใช้ได้ สำหรับข้อมูลเพิ่มเติมเกี่ยวกับงานทั่วไป โปรดดูคู่มือของนักพัฒนาซอฟต์แวร์บัญชีผู้ใช้และคู่มือชื่อแทนผู้ใช้ของนักพัฒนาซอฟต์แวร์
การแสดง JSON |
---|
{
"id": string,
"primaryEmail": string,
"password": value,
"hashFunction": string,
"isAdmin": boolean,
"isDelegatedAdmin": boolean,
"agreedToTerms": boolean,
"suspended": boolean,
"changePasswordAtNextLogin": boolean,
"ipWhitelisted": boolean,
"name": {
object ( |
ช่อง | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
รหัสที่ไม่ซ้ำกันสำหรับผู้ใช้ สามารถใช้ |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
อีเมลหลักของผู้ใช้ จำเป็นต้องระบุพร็อพเพอร์ตี้นี้ในคำขอสร้างบัญชีผู้ใช้ |
||||||||||||||||||||||||||||||||||||||||||
password |
จัดเก็บรหัสผ่านของบัญชีผู้ใช้ ต้องระบุค่ารหัสผ่านของผู้ใช้เมื่อสร้างบัญชีผู้ใช้ และไม่บังคับเมื่ออัปเดตผู้ใช้ และควรระบุเฉพาะเมื่อผู้ใช้อัปเดตรหัสผ่านของบัญชีเท่านั้น ค่ารหัสผ่านจะไม่แสดงผลในเนื้อหาการตอบสนองของ API |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
จัดเก็บรูปแบบแฮชของพร็อพเพอร์ตี้
หากระบุรอบที่เป็นส่วนหนึ่งของคำนำหน้า ต้องมีอักขระไม่เกิน 10,000 ตัว |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
เอาต์พุตเท่านั้น ระบุผู้ใช้ที่มีสิทธิ์ของผู้ดูแลระบบขั้นสูง สามารถแก้ไขพร็อพเพอร์ตี้ |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
เอาต์พุตเท่านั้น ระบุว่าผู้ใช้เป็นผู้ดูแลระบบที่ได้รับมอบสิทธิ์หรือไม่ |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
เอาต์พุตเท่านั้น พร็อพเพอร์ตี้นี้คือ |
||||||||||||||||||||||||||||||||||||||||||
suspended |
ระบุหากผู้ใช้ถูกระงับ |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
ระบุว่าผู้ใช้ถูกบังคับให้เปลี่ยนรหัสผ่านเมื่อเข้าสู่ระบบครั้งถัดไปหรือไม่ การตั้งค่านี้จะไม่มีผลเมื่อผู้ใช้ลงชื่อเข้าใช้ผ่านผู้ให้บริการข้อมูลประจำตัวบุคคลที่สาม |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
หากเป็น |
||||||||||||||||||||||||||||||||||||||||||
name |
เก็บชื่อจริงและนามสกุลของผู้ใช้ รวมถึงค่า |
||||||||||||||||||||||||||||||||||||||||||
kind |
เอาต์พุตเท่านั้น ประเภทของทรัพยากร API สำหรับทรัพยากรของผู้ใช้ ค่าจะเป็น |
||||||||||||||||||||||||||||||||||||||||||
etag |
เอาต์พุตเท่านั้น ETag ของทรัพยากร |
||||||||||||||||||||||||||||||||||||||||||
emails |
รายการอีเมลของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 10 KB
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
รายการรหัสภายนอกสำหรับผู้ใช้ เช่น พนักงานหรือรหัสเครือข่าย ขนาดข้อมูลสูงสุดที่อนุญาตคือ 2 KB
|
||||||||||||||||||||||||||||||||||||||||||
relations |
รายการความสัมพันธ์ของผู้ใช้กับผู้ใช้คนอื่นๆ ขนาดข้อมูลสูงสุดที่อนุญาตสำหรับช่องนี้คือ 2 KB โปรดดูข้อมูลเพิ่มเติมที่หัวข้อจัดการบัญชีผู้ใช้
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
เอาต์พุตเท่านั้น รายการอีเมลแทนของผู้ใช้ |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
เอาต์พุตเท่านั้น ระบุว่ามีการสร้างกล่องจดหมาย Google ของผู้ใช้หรือไม่ พร็อพเพอร์ตี้นี้จะใช้ได้ก็ต่อเมื่อผู้ใช้ได้รับใบอนุญาต Gmail เท่านั้น |
||||||||||||||||||||||||||||||||||||||||||
customerId |
เอาต์พุตเท่านั้น รหัสลูกค้าสำหรับเรียกดูผู้ใช้บัญชีทั้งหมด |
||||||||||||||||||||||||||||||||||||||||||
addresses |
รายการอีเมลของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 10 KB
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
รายชื่อองค์กรที่ผู้ใช้เป็นสมาชิก ขนาดข้อมูลสูงสุดที่อนุญาตคือ 10 KB
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
เอาต์พุตเท่านั้น เวลาล่าสุดที่ผู้ใช้เข้าสู่ระบบบัญชี ค่าจะอยู่ในรูปแบบวันที่และเวลา ISO 8601 เวลาคือวันที่แบบเต็มพร้อมชั่วโมง นาที และวินาทีในรูปแบบ |
||||||||||||||||||||||||||||||||||||||||||
phones |
รายการหมายเลขโทรศัพท์ของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 1 KB
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
เอาต์พุตเท่านั้น มีเหตุผลที่บัญชีผู้ใช้ถูกระงับโดยผู้ดูแลระบบหรือ Google ในขณะที่ถูกระงับ ระบบจะแสดงผลพร็อพเพอร์ตี้ก็ต่อเมื่อพร็อพเพอร์ตี้ |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
เอาต์พุตเท่านั้น URL รูปโปรไฟล์ของผู้ใช้ โดย URL ดังกล่าวอาจเป็น URL ชั่วคราวหรือส่วนตัว |
||||||||||||||||||||||||||||||||||||||||||
languages |
รายการภาษาของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 1 KB
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
รายการข้อมูลบัญชี POSIX ของผู้ใช้
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
เอาต์พุตเท่านั้น เวลาที่สร้างบัญชีผู้ใช้ ค่าจะอยู่ในรูปแบบวันที่และเวลา ISO 8601 เวลาคือวันที่แบบเต็มพร้อมชั่วโมง นาที และวินาทีในรูปแบบ |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
เอาต์พุตเท่านั้น รายการอีเมลแทนที่แก้ไขไม่ได้ของผู้ใช้ ซึ่งโดยปกติแล้วจะอยู่นอกโดเมนหลักหรือโดเมนย่อยของบัญชี |
||||||||||||||||||||||||||||||||||||||||||
sshPublicKeys |
รายการคีย์สาธารณะ SSH
|
||||||||||||||||||||||||||||||||||||||||||
notes |
หมายเหตุสำหรับผู้ใช้ในฐานะออบเจ็กต์ที่ซ้อนกัน
|
||||||||||||||||||||||||||||||||||||||||||
websites |
รายการเว็บไซต์ของผู้ใช้
|
||||||||||||||||||||||||||||||||||||||||||
locations |
รายการสถานที่ตั้งของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 10 KB
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
ระบุว่าโปรไฟล์ของผู้ใช้ปรากฏในรายการที่อยู่ร่วมของ Google Workspace หรือไม่เมื่อเปิดใช้ฟีเจอร์การแชร์รายชื่อติดต่อให้กับโดเมน สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการยกเว้นโปรไฟล์ผู้ใช้ โปรดดูที่ศูนย์ช่วยเหลือสำหรับผู้ดูแลระบบ |
||||||||||||||||||||||||||||||||||||||||||
keywords |
รายการคีย์เวิร์ดของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 1 KB
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
เอาต์พุตเท่านั้น เวลาที่บัญชีของผู้ใช้ถูกลบ ค่าจะอยู่ในรูปแบบวันที่และเวลา ISO 8601 เวลาคือวันที่แบบเต็มพร้อมชั่วโมง นาที และวินาทีในรูปแบบ |
||||||||||||||||||||||||||||||||||||||||||
gender |
ออบเจ็กต์ที่ฝังที่มีเพศของผู้ใช้ ขนาดสูงสุดสำหรับข้อมูลในช่องนี้คือ 1 KB
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
เอาต์พุตเท่านั้น ETag สำหรับรูปภาพของผู้ใช้ (อ่านอย่างเดียว) |
||||||||||||||||||||||||||||||||||||||||||
ims |
บัญชี Instant Messenger (IM) ของผู้ใช้ บัญชีผู้ใช้หนึ่งๆ จะมีพร็อพเพอร์ตี้
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
ช่องที่กำหนดเองของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 32 KB คีย์คือ
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
เอาต์พุตเท่านั้น ลงทะเบียนในการยืนยันแบบ 2 ขั้นตอน (อ่านอย่างเดียว) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
เอาต์พุตเท่านั้น บังคับใช้การยืนยันแบบ 2 ขั้นตอนหรือไม่ (อ่านอย่างเดียว) |
||||||||||||||||||||||||||||||||||||||||||
archived |
ระบุว่าเก็บผู้ใช้แล้วหรือยัง |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
เส้นทางแบบเต็มขององค์กรหลักที่เชื่อมโยงกับผู้ใช้ หากองค์กรระดับบนสุดคือระดับบนสุด เครื่องหมายทับจะแสดงเป็นเครื่องหมายทับ ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
อีเมลสำหรับการกู้คืนของผู้ใช้ |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
โทรศัพท์สำหรับการกู้คืนของผู้ใช้ หมายเลขโทรศัพท์ต้องอยู่ในรูปแบบ E.164 ขึ้นต้นด้วยเครื่องหมายบวก (+) เช่น +16506661212 |
ชื่อผู้ใช้
การแสดง JSON |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
ช่อง | |
---|---|
fullName |
ชื่อเต็มของผู้ใช้ที่เกิดจากการเชื่อมโยงค่าชื่อและนามสกุล |
familyName |
นามสกุลของผู้ใช้ ต้องระบุเมื่อสร้างบัญชีผู้ใช้ |
givenName |
ชื่อของผู้ใช้ ต้องระบุเมื่อสร้างบัญชีผู้ใช้ |
displayName |
ชื่อที่แสดงของผู้ใช้ จำกัด: 256 อักขระ |
วิธีการ |
|
---|---|
|
ลบผู้ใช้ |
|
เรียกข้อมูลผู้ใช้ |
|
สร้างผู้ใช้ |
|
เรียกรายการที่ใส่เลขหน้าของผู้ใช้ที่ถูกลบหรือผู้ใช้ทั้งหมดในโดเมน |
|
กำหนดให้ผู้ใช้เป็นผู้ดูแลระบบขั้นสูง |
|
อัปเดตผู้ใช้โดยใช้ความหมายของแพตช์ |
|
นำผู้ใช้ออกจากเซสชันเว็บและอุปกรณ์ทั้งหมด แล้วรีเซ็ตคุกกี้การลงชื่อเข้าใช้ของผู้ใช้ |
|
ยกเลิกการลบผู้ใช้ที่ลบแล้ว |
|
อัปเดตผู้ใช้ |
|
เฝ้าระวังการเปลี่ยนแปลงในรายการผู้ใช้ |