Method: users.get

เรียกข้อมูลผู้ใช้

คำขอ HTTP

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}

URL ใช้ไวยากรณ์ gRPC Transcoding

พารามิเตอร์เส้นทาง

พารามิเตอร์
userKey

string

ระบุผู้ใช้ในคําขอ API ค่านี้จะเป็นอีเมลหลัก อีเมลแทน หรือรหัสผู้ใช้ที่ไม่ซ้ํา

พารามิเตอร์การค้นหา

พารามิเตอร์
customFieldMask

string

รายชื่อสคีมาที่คั่นด้วยคอมมา ระบบจะดึงข้อมูลทุกช่องจากสคีมาเหล่านี้ ควรตั้งค่านี้เฉพาะเมื่อ projection=custom เท่านั้น

projection

enum (Projection)

ชุดย่อยของช่องที่จะดึงข้อมูลสําหรับผู้ใช้รายนี้

viewType

enum (ViewType)

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

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ User

ขอบเขตการให้สิทธิ์

ต้องมีขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly

โปรดดูข้อมูลเพิ่มเติมที่หัวข้อภาพรวมของ OAuth 2.0

การคาดคะเน

Enum
BASIC ไม่รวมช่องที่กําหนดเองให้ผู้ใช้
CUSTOM รวมช่องที่กําหนดเองจากสคีมาที่ขอใน customFieldMask
FULL รวมทุกช่องที่เชื่อมโยงกับผู้ใช้รายนี้

ประเภทการดู

Enum
admin_view ผลลัพธ์จะรวมถึงช่องผู้ดูแลระบบเท่านั้นและโดเมนสาธารณะของผู้ใช้
domain_public ผลลัพธ์จะรวมเฉพาะช่องสําหรับผู้ใช้รายอื่นในโดเมนเท่านั้น