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,
  "isGuestUser": boolean,
  "guestAccountInfo": {
    object (GuestAccountInfo)
  }
}
ช่อง
id

string

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

string

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

value (Value format)

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

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

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

string

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

  • MD5 - ยอมรับค่าที่เข้ารหัสแบบเลขฐานสิบหกอย่างง่าย
  • SHA-1 - ยอมรับค่าที่เข้ารหัสแบบเลขฐานสิบหกอย่างง่าย
  • crypt - เป็นไปตามไลบรารี C crypt รองรับอัลกอริทึมแฮช 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 ของผู้ใช้จะขึ้นอยู่กับการกำหนดค่า allowlist ที่อยู่ IP ที่เลิกใช้งานแล้ว
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, tty_tdd, work, work_fax, work_mobile, work_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

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

gender.customGender

string

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

gender.type

string

 ประเภทเพศ

ค่าที่ยอมรับมีดังนี้
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

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

value (Value format)

บัญชีโปรแกรมรับส่งข้อความโต้ตอบแบบทันที (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: โปรโตคอลการประชุมทางอินเทอร์เน็ต
  • 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
isGuestUser

boolean

เปลี่ยนแปลงไม่ได้ ระบุว่าผู้ใช้เป็นผู้มาเยือนหรือไม่
guestAccountInfo

object (GuestAccountInfo)

เปลี่ยนแปลงไม่ได้ ฟิลด์ข้อมูลเมตาเพิ่มเติมที่เกี่ยวข้องกับแขกรับเชิญ

UserName

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

string

ชื่อเต็มของผู้ใช้ที่สร้างขึ้นโดยการต่อค่าชื่อและนามสกุล
familyName

string

นามสกุลของผู้ใช้ ต้องระบุเมื่อสร้างบัญชีผู้ใช้
givenName

string

ชื่อของผู้ใช้ ต้องระบุเมื่อสร้างบัญชีผู้ใช้
displayName

string

ชื่อที่แสดงของผู้ใช้ ขีดจำกัด: 256 อักขระ

GuestAccountInfo

ข้อมูลบัญชีสำหรับผู้ใช้ที่เป็นแขกรับเชิญโดยเฉพาะ

การแสดง JSON 
{
  "primaryGuestEmail": string
}
ช่อง
primaryGuestEmail

string

เปลี่ยนแปลงไม่ได้ อีเมลภายนอกของผู้เข้าร่วม

เมธอด

createGuest

 สร้างผู้ใช้ชั่วคราวที่มีสิทธิ์เข้าถึงความสามารถบางอย่างของ Workspace

delete

 ลบผู้ใช้

get

 ดึงข้อมูลผู้ใช้

insert

 สร้างผู้ใช้

list

 ดึงข้อมูลรายการผู้ใช้ที่ถูกลบหรือผู้ใช้ทั้งหมดในโดเมนที่แบ่งหน้า

makeAdmin

 กำหนดให้ผู้ใช้เป็นผู้ดูแลระบบขั้นสูง

patch

 อัปเดตผู้ใช้โดยใช้แพตช์

signOut

 นำผู้ใช้ออกจากระบบในเซสชันเว็บและอุปกรณ์ทั้งหมด รวมถึงรีเซ็ตคุกกี้การลงชื่อเข้าใช้

undelete

 เลิกการลบผู้ใช้ที่ถูกลบ

update

 อัปเดตผู้ใช้

watch

 ตรวจสอบการเปลี่ยนแปลงในรายชื่อผู้ใช้