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

สําหรับข้อมูลเพิ่มเติม โปรดดูคู่มือการให้สิทธิ์

การคาดคะเน

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

ประเภทมุมมอง

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