REST Resource: users

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

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 (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) เครื่องหมายขีดกลาง (-) เครื่องหมายทับ (/) และจุด (.) ดูข้อมูลเพิ่มเติมเกี่ยวกับกฎการใช้อักขระได้ที่ศูนย์ช่วยเหลือสำหรับการดูแลระบบ ขนาดข้อมูลสูงสุดที่อนุญาตสำหรับช่องนี้คือ 1KB
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

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

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

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

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)

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

ช่อง

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, tty_tdd, work, work_fax, work_mobile, work_pager

phones[].value

string

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

string

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

string

เอาต์พุตเท่านั้น URL ของรูปโปรไฟล์ของผู้ใช้ URL ดังกล่าวอาจเป็น 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

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

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)

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

ฟิลด์

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)

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

ฟิลด์

gender.addressMeAs

string

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

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 จะมีค่าเป็น "จริง" ได้เพียงรายการเดียว

ims[].protocol

string

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

ค่าที่ยอมรับ:
  • aim: โปรโตคอล AOL Instant Messenger
  • custom_protocol: โปรโตคอลเครือข่าย IM ที่กําหนดเอง
  • gtalk: โปรโตคอล Google Talk
  • icq: โปรโตคอล ICQ
  • jabber: โปรโตคอล Jabber
  • msn: โปรโตคอล MSN Messenger
  • net_meeting: โปรโตคอล 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

 คอยดูการเปลี่ยนแปลงในรายชื่อผู้ใช้