หน้านี้ได้รับการแปลโดย Cloud Translation API

REST Resource: users

แหล่งข้อมูล: ผู้ใช้

Directory API ช่วยให้คุณสร้างและจัดการผู้ใช้ของบัญชี ชื่อแทนผู้ใช้ และรูปโปรไฟล์ Google ของผู้ใช้ได้ สำหรับข้อมูลเพิ่มเติมเกี่ยวกับงานทั่วไป โปรดดูคู่มือนักพัฒนาบัญชีผู้ใช้ และคู่มือนักพัฒนาซอฟต์แวร์ชื่อแทนผู้ใช้

การแสดง JSON

การแสดง JSON
{ "id": string, "primaryEmail": string, "password": value, "hashFunction": string, "isAdmin": boolean, "isDelegatedAdmin": boolean, "agreedToTerms": boolean, "suspended": boolean, "changePasswordAtNextLogin": boolean, "ipWhitelisted": boolean, "name": { object (`UserName`) }, "kind": string, "etag": string, "emails": value, "externalIds": value, "relations": value, "aliases": [ string ], "isMailboxSetup": boolean, "customerId": string, "addresses": value, "organizations": value, "lastLoginTime": string, "phones": value, "suspensionReason": string, "thumbnailPhotoUrl": string, "languages": value, "posixAccounts": value, "creationTime": string, "nonEditableAliases": [ string ], "sshPublicKeys": value, "notes": value, "websites": value, "locations": value, "includeInGlobalAddressList": boolean, "keywords": value, "deletionTime": string, "gender": value, "thumbnailPhotoEtag": string, "ims": value, "customSchemas": value, "isEnrolledIn2Sv": boolean, "isEnforcedIn2Sv": boolean, "archived": boolean, "orgUnitPath": string, "recoveryEmail": string, "recoveryPhone": string }

{
  "id": string,
  "primaryEmail": string,
  "password": value,
  "hashFunction": string,
  "isAdmin": boolean,
  "isDelegatedAdmin": boolean,
  "agreedToTerms": boolean,
  "suspended": boolean,
  "changePasswordAtNextLogin": boolean,
  "ipWhitelisted": boolean,
  "name": {
    object (UserName)
  },
  "kind": string,
  "etag": string,
  "emails": value,
  "externalIds": value,
  "relations": value,
  "aliases": [
    string
  ],
  "isMailboxSetup": boolean,
  "customerId": string,
  "addresses": value,
  "organizations": value,
  "lastLoginTime": string,
  "phones": value,
  "suspensionReason": string,
  "thumbnailPhotoUrl": string,
  "languages": value,
  "posixAccounts": value,
  "creationTime": string,
  "nonEditableAliases": [
    string
  ],
  "sshPublicKeys": value,
  "notes": value,
  "websites": value,
  "locations": value,
  "includeInGlobalAddressList": boolean,
  "keywords": value,
  "deletionTime": string,
  "gender": value,
  "thumbnailPhotoEtag": string,
  "ims": value,
  "customSchemas": value,
  "isEnrolledIn2Sv": boolean,
  "isEnforcedIn2Sv": boolean,
  "archived": boolean,
  "orgUnitPath": string,
  "recoveryEmail": string,
  "recoveryPhone": string
}

ช่อง

id

string

รหัสที่ไม่ซ้ำกันสำหรับผู้ใช้ ผู้ใช้ id สามารถใช้เป็น userKey ของ URI คำขอของผู้ใช้ได้

primaryEmail

string

อีเมลหลักของผู้ใช้ ต้องระบุพร็อพเพอร์ตี้นี้ในคำขอเพื่อสร้างบัญชีผู้ใช้ primaryEmail ต้องไม่ซ้ำกันและต้องไม่เป็นชื่อแทนของผู้ใช้รายอื่น

password

value (Value format)

จัดเก็บรหัสผ่านสำหรับบัญชีผู้ใช้ ต้องระบุค่ารหัสผ่านของผู้ใช้เมื่อสร้างบัญชีผู้ใช้ หรือไม่ต้องระบุเมื่ออัปเดตผู้ใช้ และควรระบุเฉพาะเมื่อผู้ใช้กำลังอัปเดตรหัสผ่านของบัญชีของตนเท่านั้น ส่วนเนื้อหาการตอบกลับของ API จะไม่แสดงค่ารหัสผ่าน

รหัสผ่านสามารถใช้อักขระ ASCII ผสมกันแบบใดก็ได้ และต้องมีความยาวระหว่าง 8-100 อักขระ

เราขอแนะนำให้ส่งพารามิเตอร์ password เป็นค่าแฮชที่เข้ารหัสเลขฐาน 16 และตั้งค่า hashFunction ให้สอดคล้องกัน หากระบุ hashFunction แล้ว รหัสผ่านต้องเป็นคีย์แฮชที่ถูกต้อง

hashFunction

string

จัดเก็บรูปแบบแฮชของพร็อพเพอร์ตี้ password ค่า hashFunction ที่ใช้ได้มีดังนี้

MD5 - ยอมรับค่าที่เข้ารหัสเลขฐาน 16 แบบง่าย
SHA-1 - ยอมรับค่าที่เข้ารหัสเลขฐาน 16 แบบง่าย
crypt - เป็นไปตามไลบรารีการเข้ารหัส C รองรับอัลกอริทึมแฮช DES, MD5 (ค่านำหน้าแฮช $1$ ), SHA-256 (ค่านำหน้าแฮช $5$ ) และ SHA-512 (ค่านำหน้าแฮช $6$ )

หากระบุรอบเป็นส่วนหนึ่งของคำนำหน้า จำนวนรอบจะต้องไม่เกิน 10,000 รอบ

isAdmin

boolean

เอาต์พุตเท่านั้น ระบุผู้ใช้ที่มีสิทธิ์ผู้ดูแลระบบขั้นสูง แก้ไขพร็อพเพอร์ตี้ isAdmin ได้ในการดำเนินการกำหนดให้ผู้ใช้เป็นผู้ดูแลระบบเท่านั้น ( เมธอด makeAdmin) หากแก้ไขในเมธอด insert หรือ update ของผู้ใช้ บริการ API จะไม่สนใจการแก้ไขดังกล่าว

isDelegatedAdmin

boolean

เอาต์พุตเท่านั้น ระบุว่าผู้ใช้เป็นผู้ดูแลระบบที่ได้รับมอบสิทธิ์หรือไม่
API รองรับผู้ดูแลระบบที่ได้รับมอบสิทธิ์แต่จะสร้างหรือยกเลิกการลบผู้ใช้ หรือกําหนดให้เป็นผู้ดูแลระบบของผู้ใช้ไม่ได้ บริการ API จะไม่สนใจคำขอเหล่านี้
บทบาทและสิทธิ์สำหรับผู้ดูแลระบบจะกำหนดโดยใช้คอนโซลผู้ดูแลระบบ

agreedToTerms

boolean

เอาต์พุตเท่านั้น พร็อพเพอร์ตี้นี้คือ true หากผู้ใช้เข้าสู่ระบบครั้งแรกและยอมรับข้อตกลงเกี่ยวกับข้อกำหนดในการให้บริการแล้ว

suspended

boolean

ระบุว่าผู้ใช้ถูกระงับหรือไม่

changePasswordAtNextLogin

boolean

ระบุว่าบังคับให้ผู้ใช้เปลี่ยนรหัสผ่านเมื่อเข้าสู่ระบบครั้งถัดไปหรือไม่ การตั้งค่านี้จะไม่มีผลเมื่อผู้ใช้ลงชื่อเข้าใช้ผ่านผู้ให้บริการข้อมูลประจำตัวบุคคลที่สาม

ipWhitelisted

boolean

หากเป็น true ที่อยู่ IP ของผู้ใช้จะอยู่ภายใต้การกำหนดค่าที่อยู่ IP allowlist ที่เลิกใช้งานแล้ว

name

object (UserName)

เก็บชื่อจริงและนามสกุลของผู้ใช้ และค่า fullName แบบอ่านอย่างเดียว จำนวนอักขระสูงสุดในค่า givenName และใน familyName คือ 60 อักขระ นอกจากนี้ ค่าชื่อยังรองรับอักขระ unicode/UTF-8 และมีการเว้นวรรค ตัวอักษร (a-z) ตัวเลข (0-9) ขีดกลาง (-) เครื่องหมายทับ (/) และจุด (.) ได้ด้วย โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับกฎการใช้งานอักขระที่ศูนย์ช่วยเหลือสำหรับการดูแลระบบ ขนาดข้อมูลสูงสุดที่อนุญาตของช่องนี้คือ 1 KB

kind

string

เอาต์พุตเท่านั้น ประเภทของทรัพยากร API สำหรับทรัพยากรของผู้ใช้ ค่าคือ admin#directory#user

etag

string

เอาต์พุตเท่านั้น ETag ของทรัพยากร

emails

value (Value format)

รายการอีเมลของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 10 KB

ช่อง

emails[].address

string

อีเมลของผู้ใช้ และเป็นรหัสอีเมลด้วย ค่านี้อาจเป็นอีเมลหลักหรือชื่อแทนของผู้ใช้ก็ได้

emails[].customType

string

หากอีเมล type คือ custom พร็อพเพอร์ตี้นี้มีค่าที่กําหนดเองและต้องตั้งค่า

emails[].primary

boolean

ระบุว่าเป็นอีเมลหลักของผู้ใช้หรือไม่ ทำเครื่องหมายเป็นรายการหลักได้เพียง 1 รายการเท่านั้น

emails[].type

string

ประเภทของบัญชีอีเมล หากตั้งค่าเป็น custom ต้องตั้งค่า customType ด้วย

ค่าที่ยอมรับได้ ได้แก่ custom, home, other, work

externalIds

value (Value format)

รายการรหัสภายนอกของผู้ใช้ เช่น รหัสพนักงานหรือรหัสเครือข่าย ขนาดข้อมูลสูงสุดที่อนุญาตคือ 2 KB

ช่อง

externalIds[].customType

string

หากรหัสภายนอก type คือ custom พร็อพเพอร์ตี้นี้จะมีค่าที่กำหนดเองและต้องตั้งค่า

externalIds[].type

string

ประเภทของรหัสภายนอก หากตั้งค่าเป็น custom ต้องตั้งค่า customType ด้วย

ค่าที่ยอมรับได้ ได้แก่ account, custom, customer, login_id, network, organization

externalIds[].value

string

ค่าของรหัสภายนอก

relations

value (Value format)

รายการความสัมพันธ์ของผู้ใช้กับผู้ใช้คนอื่นๆ ขนาดข้อมูลสูงสุดที่อนุญาตของช่องนี้คือ 2 KB โปรดดูข้อมูลเพิ่มเติมที่หัวข้อจัดการบัญชีผู้ใช้

ช่อง

relations[].customType

string

หากความสัมพันธ์ type คือ custom พร็อพเพอร์ตี้นี้มีค่าที่กำหนดเองและต้องตั้งค่า

relations[].type

string

ประเภทของความสัมพันธ์ หากตั้งค่าเป็น custom ต้องตั้งค่า customType ด้วย

ค่าที่ยอมรับได้:

admin_assistant
assistant
brother
child
custom
domestic_partner
dotted_line_manager
exec_assistant
father
friend
manager
mother
parent
partner
referred_by
relative
sister
spouse

relations[].value

string

อีเมลของบุคคลที่เกี่ยวข้อง

aliases[]

string

เอาต์พุตเท่านั้น รายการอีเมลชื่อแทนของผู้ใช้

isMailboxSetup

boolean

เอาต์พุตเท่านั้น ระบุว่ามีการสร้างกล่องจดหมาย Google ของผู้ใช้หรือไม่ พร็อพเพอร์ตี้นี้จะมีผลก็ต่อเมื่อผู้ใช้ได้รับมอบหมายใบอนุญาต Gmail เท่านั้น

customerId

string

เอาต์พุตเท่านั้น รหัสลูกค้าเพื่อเรียกข้อมูลผู้ใช้บัญชีทั้งหมด
คุณสามารถใช้ชื่อแทน my_customer เพื่อแสดง customerId ของบัญชี
ในฐานะผู้ดูแลระบบของตัวแทนจำหน่าย คุณสามารถใช้ customerId ของบัญชีลูกค้าจากพาร์ทเนอร์ได้ หากต้องการรับ customerId ให้ใช้โดเมนหลักของบัญชีในพารามิเตอร์ domain ของคำขอ users.list

addresses

value (Value format)

รายการอีเมลของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 10 KB

ช่อง

addresses[].country

string

ประเทศ

addresses[].countryCode

string

รหัสประเทศ ใช้มาตรฐาน ISO 3166-1

addresses[].customType

string

หากที่อยู่ type คือ custom พร็อพเพอร์ตี้นี้มีค่าที่กำหนดเองและต้องตั้งค่า

addresses[].extendedAddress

string

สำหรับที่อยู่ขยาย เช่น ที่อยู่ที่มีภูมิภาคย่อย

addresses[].formatted

string

ที่อยู่ไปรษณีย์แบบเต็มและไม่มีโครงสร้าง ข้อมูลนี้จะไม่ซิงค์กับช่องที่อยู่ที่มีโครงสร้าง รวมแอตทริบิวต์ต่อไปนี้: ที่อยู่, ป.ณ. กล่อง เมือง รัฐ/จังหวัด รหัสไปรษณีย์ ประเทศ/ภูมิภาค

addresses[].locality

string

เมืองของที่อยู่

addresses[].poBox

string

ตู้ไปรษณีย์ (หากมี)

addresses[].postalCode

string

รหัสไปรษณีย์ (หากมี)

addresses[].primary

boolean

หากนี่คืออีเมลหลักของผู้ใช้ รายการที่อยู่มีที่อยู่หลักได้เพียงรายการเดียว

addresses[].region

string

จังหวัดหรือรัฐแบบย่อ

addresses[].sourceIsStructured

boolean

บ่งบอกว่ามีการจัดรูปแบบที่อยู่ที่ผู้ใช้ให้ไว้หรือไม่ ปัจจุบันยังไม่รองรับที่อยู่ที่จัดรูปแบบ

addresses[].streetAddress

string

ที่อยู่ เช่น 1600 Amphitheatre Parkway ระบบจะละเว้นช่องว่างภายในสตริง อย่างไรก็ตาม บรรทัดใหม่นั้นสำคัญ

addresses[].type

string

ประเภทที่อยู่ หากตั้งค่าเป็น custom ต้องตั้งค่า customType ด้วย

ค่าที่ยอมรับได้ ได้แก่ custom, home, other, work

organizations

value (Value format)

รายชื่อองค์กรที่ผู้ใช้เป็นสมาชิก ขนาดข้อมูลสูงสุดที่อนุญาตคือ 10 KB

ช่อง

organizations[].costCenter

string

ศูนย์ต้นทุนขององค์กรของผู้ใช้

organizations[].customType

string

หากค่าของประเภทเป็นแบบกำหนดเอง พร็อพเพอร์ตี้นี้จะมีประเภทที่กำหนดเอง

organizations[].department

string

ระบุแผนกภายในองค์กร เช่น sales หรือ engineering

organizations[].description

string

คำอธิบายขององค์กร

organizations[].domain

string

โดเมนที่เป็นขององค์กร

organizations[].fullTimeEquivalent

integer

ค่ามิลลิเปอร์เซ็นต์เทียบเท่าแบบเต็มเวลาภายในองค์กร (100000 = 100%)

organizations[].location

string

สถานที่ตั้งจริงขององค์กร ซึ่งไม่จำเป็นต้องเป็นที่อยู่ที่สมบูรณ์ในตัวเอง

organizations[].name

string

ชื่อขององค์กร

organizations[].primary

boolean

ระบุว่านี่คือองค์กรหลักของผู้ใช้หรือไม่ ผู้ใช้จะมีองค์กรหลักได้เพียงองค์กรเดียว

organizations[].symbol

string

สัญลักษณ์สตริงข้อความขององค์กร เช่น สัญลักษณ์ข้อความสำหรับ Google คือ GOOG

organizations[].title

string

ตำแหน่งของผู้ใช้ภายในองค์กร เช่น member หรือ engineer

organizations[].type

string

ประเภทขององค์กร

ค่าที่ยอมรับ: domain_only, school, unknown, work

lastLoginTime

string

เอาต์พุตเท่านั้น เวลาล่าสุดที่ผู้ใช้เข้าสู่ระบบบัญชีของผู้ใช้ ค่าจะอยู่ในรูปแบบวันที่และเวลา ISO 8601 เวลาคือวันที่แบบเต็มพร้อมชั่วโมง นาที และวินาทีในรูปแบบ YYYY-MM-DDThh:mm:ssTZD เช่น 2010-04-05T17:30:04+01:00

phones

value (Value format)

รายการหมายเลขโทรศัพท์ของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 1 KB

ช่อง

phones[].customType

string

หากหมายเลขโทรศัพท์ type คือ custom พร็อพเพอร์ตี้นี้มีค่าที่กำหนดเองและต้องตั้งค่า

phones[].primary

boolean

หากเป็น true นี่คือหมายเลขโทรศัพท์หลักของผู้ใช้ ผู้ใช้จะมีหมายเลขโทรศัพท์หลักได้เพียงหมายเลขเดียว

phones[].type

string

ประเภทของหมายเลขโทรศัพท์ หากตั้งค่าเป็น custom คุณจะต้องตั้งค่า customType ด้วย

ค่าที่ยอมรับได้ ได้แก่ assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, work_fax, {2/1}, work_faxtty_tddworkwork_mobilework_pager

phones[].value

string

หมายเลขโทรศัพท์ที่มนุษย์อ่านได้ ซึ่งจะอยู่ในรูปแบบหมายเลขโทรศัพท์ใดก็ได้

suspensionReason

string

เอาต์พุตเท่านั้น มีเหตุผลที่ผู้ดูแลระบบหรือ Google ระงับบัญชีผู้ใช้ในขณะที่มีการระงับ ระบบจะแสดงผลพร็อพเพอร์ตี้ต่อเมื่อพร็อพเพอร์ตี้ suspended คือ true

thumbnailPhotoUrl

string

เอาต์พุตเท่านั้น URL ของรูปโปรไฟล์ของผู้ใช้ URL นี้อาจเป็นแบบชั่วคราวหรือส่วนตัว

languages

value (Value format)

รายการภาษาของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 1 KB

ช่อง

languages[].customLanguage

string

ภาษาอื่นๆ ผู้ใช้จะระบุชื่อภาษาของตนเองได้หากไม่มีรหัสภาษา ISO 639 ที่เกี่ยวข้อง หากตั้งค่าแล้วจะตั้ง languageCode ไม่ได้

languages[].languageCode

string

การแสดงสตริง ISO 639 ของภาษา โปรดดูรหัสภาษาสำหรับรายการรหัสที่รองรับ API ยอมรับรหัสภาษาที่ถูกต้องซึ่งไม่ได้อยู่ในชุดที่รองรับ แต่อาจส่งผลให้เกิดลักษณะการทำงานที่ไม่คาดคิด ค่าที่ไม่ถูกต้องจะทําให้เกิด SchemaException หากตั้งค่าแล้วจะตั้ง customLanguage ไม่ได้

languages[].preference

string

ไม่บังคับ หากมี ให้ควบคุมว่า languageCode ที่ระบุเป็นภาษาที่ผู้ใช้ต้องการหรือไม่ หากตั้งค่า customLanguage ไว้ คุณจะตั้งค่านี้ไม่ได้ ค่าที่อนุญาตคือ preferred และ not_preferred

posixAccounts

value (Value format)

รายการข้อมูลบัญชี POSIX ของผู้ใช้

ช่อง

posixAccounts[].accountId

string

ตัวระบุช่องบัญชี POSIX

posixAccounts[].gecos

string

GECOS (ข้อมูลผู้ใช้) สำหรับบัญชีนี้

posixAccounts[].gid

unsigned long

รหัสกลุ่มสินค้าเริ่มต้น

posixAccounts[].homeDirectory

string

เส้นทางไปยังไดเรกทอรีหน้าแรกสำหรับบัญชีนี้

posixAccounts[].operatingSystemType

string

ประเภทของระบบปฏิบัติการสำหรับบัญชีนี้

ค่าที่ยอมรับ: linux, unspecified, windows

posixAccounts[].primary

boolean

หากนี่เป็นบัญชีหลักของผู้ใช้ภายใน SystemId

posixAccounts[].shell

string

เส้นทางไปยังเชลล์การเข้าสู่ระบบสำหรับบัญชีนี้

posixAccounts[].systemId

string

ตัวระบุระบบที่ใช้ชื่อผู้ใช้หรือ Uid ของบัญชี

posixAccounts[].uid

unsigned long

รหัสผู้ใช้ที่เป็นไปตามข้อกำหนดของ POSIX

posixAccounts[].username

string

ชื่อผู้ใช้ของบัญชี

creationTime

string

เอาต์พุตเท่านั้น เวลาที่สร้างบัญชีของผู้ใช้ ค่าจะอยู่ในรูปแบบวันที่และเวลา ISO 8601 เวลาคือวันที่แบบเต็มพร้อมชั่วโมง นาที และวินาทีในรูปแบบ YYYY-MM-DDThh:mm:ssTZD เช่น 2010-04-05T17:30:04+01:00

nonEditableAliases[]

string

เอาต์พุตเท่านั้น รายการอีเมลแฝงที่แก้ไขไม่ได้ของผู้ใช้ ซึ่งโดยทั่วไปจะอยู่นอกโดเมนหลักหรือโดเมนย่อยของบัญชี

sshPublicKeys

value (Value format)

รายการคีย์สาธารณะ SSH

ช่อง

sshPublicKeys[].expirationTimeUsec

long

เวลาหมดอายุในหน่วยไมโครวินาทีนับตั้งแต่ Epoch

sshPublicKeys[].fingerprint

string

ลายนิ้วมือ SHA-256 ของคีย์สาธารณะ SSH (อ่านอย่างเดียว)

sshPublicKeys[].key

string

คีย์สาธารณะ SSH

notes

value (Value format)

หมายเหตุสำหรับผู้ใช้ในรูปแบบออบเจ็กต์ที่ฝัง

ช่อง

notes.contentType

string

ประเภทเนื้อหาของโน้ตไม่ว่าจะเป็นข้อความธรรมดาหรือ HTML ค่าเริ่มต้นคือข้อความธรรมดา

ค่าที่ยอมรับ: text_plain, text_html

notes.value

string

เนื้อหาของหมายเหตุ

websites

value (Value format)

รายการเว็บไซต์ของผู้ใช้

ช่อง

websites[].customType

string

หากเว็บไซต์ type คือ custom พร็อพเพอร์ตี้นี้มีค่าที่กำหนดเองและต้องตั้งค่า

websites[].primary

boolean

หากเป็น true นี่คือเว็บไซต์หลักของผู้ใช้

websites[].type

string

ประเภทหรือวัตถุประสงค์ของเว็บไซต์ ตัวอย่างเช่น เว็บไซต์อาจติดป้ายกำกับเป็น home หรือ blog นอกจากนี้ รายการอาจมีประเภท custom ก็ได้ หากตั้งค่าเป็น custom คุณต้องตั้งค่า customType ด้วย

ค่าที่ยอมรับได้ ได้แก่ app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work

websites[].value

string

URL ของเว็บไซต์

locations

value (Value format)

รายการสถานที่ตั้งของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 10 KB

ช่อง

locations[].area

string

ตำแหน่งของข้อความ ซึ่งจะเป็นประโยชน์มากที่สุดสำหรับการแสดงผลเพื่อให้อธิบายสถานที่ได้กระชับ เช่น Mountain View, CA หรือ Near Seattle

locations[].buildingId

string

ตัวระบุอาคาร

locations[].customType

string

หากสถานที่ตั้ง type คือ custom พร็อพเพอร์ตี้นี้มีค่าที่กำหนดเองและต้องตั้งค่า

locations[].deskCode

string

รหัสแบบข้อความที่เจาะจงที่สุดของโต๊ะทำงานแต่ละแห่ง

locations[].floorName

string

ชื่อ/หมายเลขชั้น

locations[].floorSection

string

ชั้น ตำแหน่งที่เฉพาะเจาะจงภายในชั้นมากขึ้น ตัวอย่างเช่น หากราคาพื้นแบ่งออกเป็นส่วน A, B และ C ช่องนี้จะระบุค่าใดค่าหนึ่ง

locations[].type

string

ประเภทสถานที่ตั้ง หากตั้งค่าเป็น custom ต้องตั้งค่า customType ด้วย

ค่าที่ยอมรับได้ ได้แก่ custom, default, desk

includeInGlobalAddressList

boolean

ระบุว่าโปรไฟล์ของผู้ใช้ปรากฏในรายการที่อยู่ร่วมของ Google Workspace หรือไม่เมื่อเปิดใช้ฟีเจอร์การแชร์รายชื่อติดต่อสำหรับโดเมน สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการยกเว้นโปรไฟล์ผู้ใช้ โปรดดูที่ศูนย์ช่วยเหลือสำหรับการดูแลระบบ

keywords

value (Value format)

รายการคีย์เวิร์ดของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตคือ 1 KB

ช่อง

keywords[].customType

string

หากคีย์เวิร์ด type คือ custom พร็อพเพอร์ตี้นี้มีค่าที่กำหนดเองและต้องตั้งค่า

keywords[].type

string

ซึ่งแต่ละรายการจะมีประเภทที่ระบุประเภทมาตรฐานของรายการนั้นได้

เช่น คีย์เวิร์ดอาจเป็นประเภท occupation หรือ outlook นอกเหนือจากประเภทมาตรฐานแล้ว รายการอาจมีประเภท custom และตั้งชื่อใดก็ได้ หากตั้งค่าเป็น custom ต้องตั้งค่า customType ด้วย

ค่าที่ยอมรับได้ ได้แก่ custom, mission, occupation, outlook

keywords[].value

string

คีย์เวิร์ด

deletionTime

string

เอาต์พุตเท่านั้น เวลาที่บัญชีของผู้ใช้ถูกลบ ค่าจะอยู่ในรูปแบบวันที่และเวลา ISO 8601 เวลาคือวันที่แบบเต็มพร้อมชั่วโมง นาที และวินาทีในรูปแบบ YYYY-MM-DDThh:mm:ssTZD เช่น 2010-04-05T17:30:04+01:00

gender

value (Value format)

ออบเจ็กต์ที่ฝังซึ่งมีเพศของผู้ใช้ ขนาดข้อมูลสูงสุดที่อนุญาตของช่องนี้คือ 1 KB

ช่อง

gender.addressMeAs

string

สตริงที่มนุษย์อ่านได้ ซึ่งมีวิธีที่เหมาะสมในการอ้างอิงเจ้าของโปรไฟล์โดยเจ้าหน้าที่ เช่น "he/him/his" หรือ "พวกเขา/พวกเขา/ของพวกเขา"

gender.customGender

string

ชื่อของเพศที่กำหนดเอง

gender.type

string

ประเภทของเพศ

ค่าที่ยอมรับ:

female
male
other
unknown

thumbnailPhotoEtag

string

เอาต์พุตเท่านั้น ETag ของรูปภาพของผู้ใช้ (อ่านอย่างเดียว)

ims

value (Value format)

บัญชี Instant Messenger (IM) ของผู้ใช้ บัญชีผู้ใช้หนึ่งสามารถมีพร็อพเพอร์ตี้ ims ได้หลายรายการ แต่พร็อพเพอร์ตี้ ims เหล่านี้เพียงรายการเดียวเท่านั้นที่สามารถเป็นผู้ติดต่อหลัก IM

ช่อง

ims[].customProtocol

string

หากค่าโปรโตคอลคือ custom_protocol พร็อพเพอร์ตี้นี้จะเก็บสตริงของโปรโตคอลที่กำหนดเองไว้

ims[].customType

string

หาก IM type คือ custom พร็อพเพอร์ตี้นี้มีค่าที่กำหนดเองและต้องตั้งค่า

ims[].im

string

รหัสเครือข่าย IM ของผู้ใช้

ims[].primary

boolean

ถ้านี่คือ IM หลักของผู้ใช้ ข้อความในรายการ IM เดียวเท่านั้นที่สามารถมีค่าเป็น true ได้

ims[].protocol

string

โปรโตคอล IM จะระบุเครือข่าย IM ค่านี้อาจเป็นเครือข่ายที่กำหนดเองหรือเครือข่ายมาตรฐาน

ค่าที่ยอมรับ:

aim: โปรโตคอล AOL Instant Messenger
custom_protocol: โปรโตคอลเครือข่าย IM ที่กำหนดเอง
gtalk: โปรโตคอลของ Google Talk
icq: โปรโตคอล ICQ
jabber: โปรโตคอล Jabber
msn: โปรโตคอลของ MSN Messenger
net_meeting: โปรโตคอลการประชุมสุทธิ
qq: โปรโตคอล QQ
skype: โปรโตคอล Skype
yahoo: โปรโตคอล Yahoo Messenger

ims[].type

string

ประเภทของบัญชี IM หากตั้งค่าเป็น custom ต้องตั้งค่า customType ด้วย

ค่าที่ยอมรับได้ ได้แก่ custom, home, other, work

customSchemas

value (Value format)

ช่องที่กำหนดเองของผู้ใช้ คีย์คือ schemaName และค่าคือ 'fieldName': 'field_value'

customSchemas.(key) เป็นออบเจ็กต์ที่ฝัง
customSchemas.(key).(key) จะเป็นค่าใดก็ได้

isEnrolledIn2Sv

boolean

เอาต์พุตเท่านั้น ลงทะเบียนในการยืนยันแบบ 2 ขั้นตอน (อ่านอย่างเดียว)

isEnforcedIn2Sv

boolean

เอาต์พุตเท่านั้น มีการบังคับใช้การยืนยันแบบ 2 ขั้นตอน (อ่านอย่างเดียว)

archived

boolean

ระบุว่าเก็บผู้ใช้แล้วหรือไม่

orgUnitPath

string

เส้นทางแบบเต็มขององค์กรหลักที่เชื่อมโยงกับผู้ใช้ หากองค์กรหลักเป็นระดับบนสุด ระบบจะแสดงเครื่องหมายทับ (/)

recoveryEmail

string

อีเมลสำหรับการกู้คืนของผู้ใช้

recoveryPhone

string

หมายเลขโทรศัพท์สำหรับการกู้คืนของผู้ใช้ หมายเลขโทรศัพท์ต้องอยู่ในรูปแบบ E.164 ซึ่งเริ่มด้วยเครื่องหมายบวก (+) ตัวอย่างเช่น +16506661212

UserName

การแสดง JSON
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string }

ช่อง
`fullName`	`string` ชื่อเต็มของผู้ใช้ที่เกิดจากการเชื่อมค่าชื่อและนามสกุล
`familyName`	`string` นามสกุลของผู้ใช้ ต้องระบุเมื่อสร้างบัญชีผู้ใช้
`givenName`	`string` ชื่อของผู้ใช้ ต้องระบุเมื่อสร้างบัญชีผู้ใช้
`displayName`	`string` ชื่อที่แสดงของผู้ใช้ จำกัด: 256 อักขระ

เมธอด
`delete`	ลบผู้ใช้
`get`	เรียกข้อมูลผู้ใช้
`insert`	สร้างผู้ใช้
`list`	เรียกข้อมูลรายการที่ใส่เลขหน้าของผู้ใช้ที่ถูกลบหรือผู้ใช้ทั้งหมดในโดเมน
`makeAdmin`	กำหนดให้ผู้ใช้เป็นผู้ดูแลระบบขั้นสูง
`patch`	อัปเดตผู้ใช้โดยใช้ความหมายของแพตช์
`signOut`	นำผู้ใช้ออกจากเซสชันเว็บและอุปกรณ์ทั้งหมดและรีเซ็ตคุกกี้การลงชื่อเข้าใช้
`undelete`	ยกเลิกการลบผู้ใช้ที่ถูกลบ
`update`	อัปเดตผู้ใช้
`watch`	คอยดูการเปลี่ยนแปลงในรายชื่อผู้ใช้

REST Resource: users

แหล่งข้อมูล: ผู้ใช้

UserName

เมธอด

`delete`

`get`

`insert`

`list`

`makeAdmin`

`patch`

`signOut`

`undelete`

`update`

`watch`