Method: users.get

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

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

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

พารามิเตอร์
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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์

การฉายภาพ

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

ViewType

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