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 เป็นค่าแฮชที่เข้ารหัสเลขฐานสิบหกและตั้งค่า hashFunction ให้สอดคล้องกัน หากระบุ hashFunction ไว้ รหัสผ่านต้องเป็นคีย์แฮชที่ถูกต้อง
hashFunction

string

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

  • MD5 - ยอมรับค่าที่เข้ารหัสฐานสิบหกแบบธรรมดา
  • SHA-1 - ยอมรับค่าที่เข้ารหัสฐานสิบหกแบบธรรมดา
  • crypt - สอดคล้องกับไลบรารี C crypt Library รองรับอัลกอริทึมแฮช 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

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

organizations[].location

string

สถานที่ตั้งจริงขององค์กร โดยไม่จำเป็นต้องเป็นที่อยู่แบบเต็ม

organizations[].name

string

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

organizations[].primary

boolean

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

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, telex, tty_tdd, telex, tty_tdd, telex, work, telex, workwork_faxwork_mobilework_pager

phones[].value

string

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

string

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

string

เอาต์พุตเท่านั้น 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

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

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)

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

ช่อง

ims[].customProtocol

string

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

ims[].customType

string

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

ims[].im

string

ID เครือข่าย 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

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

 เฝ้าระวังการเปลี่ยนแปลงในรายการผู้ใช้