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 ผลลัพธ์จะมีเฉพาะฟิลด์ของผู้ใช้ ซึ่งเป็นที่ปรากฏแบบสาธารณะต่อผู้ใช้รายอื่นในโดเมน