Method: users.list

เรียกข้อมูลรายการที่ใส่เลขหน้าของผู้ใช้ที่ถูกลบหรือผู้ใช้ทั้งหมดในโดเมน

คำขอ HTTP

GET https://admin.googleapis.com/admin/directory/v1/users

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

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

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

string

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

string

รหัสที่ไม่ซ้ำกันสำหรับบัญชี Google Workspace ของลูกค้า ในกรณีที่เป็นบัญชีหลายโดเมน หากต้องการดึงข้อมูลผู้ใช้ทั้งหมดสำหรับลูกค้า ให้ใช้ช่องนี้แทน domain คุณยังใช้ชื่อแทน my_customer เพื่อแสดง customerId ของบัญชีได้ด้วย และจะแสดงผล customerId เป็นส่วนหนึ่งของทรัพยากร Users ด้วย คุณต้องระบุพารามิเตอร์ customer หรือ domain
domain

string

ชื่อโดเมน ใช้ช่องนี้เพื่อรับผู้ใช้จากโดเมนเดียวเท่านั้น หากต้องการแสดงโดเมนทั้งหมดสำหรับบัญชีลูกค้า ให้ใช้พารามิเตอร์การค้นหา customer แทน ต้องระบุพารามิเตอร์ customer หรือ domain
event

enum (Event)

เหตุการณ์ที่ต้องการสมัครใช้บริการ (หากสมัครใช้บริการ)
maxResults

integer

จำนวนผลลัพธ์สูงสุดที่จะแสดง
orderBy

enum (OrderBy)

พร็อพเพอร์ตี้ที่ใช้สำหรับการจัดเรียงผลลัพธ์
pageToken

string

โทเค็นที่จะระบุหน้าถัดไปในรายการ
projection

enum (Projection)

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

string

สตริงการค้นหาสําหรับการค้นหาช่องผู้ใช้ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับการสร้างคำค้นหาของผู้ใช้ที่หัวข้อค้นหาผู้ใช้
showDeleted

string

หากตั้งค่าเป็น true จะเรียกข้อมูลรายชื่อผู้ใช้ที่ลบไปแล้ว (ค่าเริ่มต้น: false)
sortOrder

enum (SortOrder)

ไม่ว่าจะแสดงผลลัพธ์ในลำดับจากน้อยไปมากหรือมากไปน้อย โดยไม่คำนึงถึงตัวพิมพ์ใหญ่/เล็ก
viewType

enum (ViewType)

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

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

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

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

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
ช่อง
kind

string

นี่เป็นแหล่งข้อมูล
trigger_event

string

เหตุการณ์ที่ทริกเกอร์การตอบกลับนี้ (ใช้ในกรณีของ Push Response เท่านั้น)
etag

string

ETag ของทรัพยากร
users[]

object (User)

รายการออบเจ็กต์ผู้ใช้
nextPageToken

string

โทเค็นที่ใช้ในการเข้าถึงหน้าถัดไปของผลการค้นหานี้

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

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

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

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

เหตุการณ์

ประเภทเหตุการณ์การสมัครใช้บริการ

Enum
ADD เหตุการณ์ที่ผู้ใช้สร้าง
DELETE กิจกรรมที่ผู้ใช้ลบ
MAKE_ADMIN เหตุการณ์การเปลี่ยนสถานะผู้ดูแลระบบของผู้ใช้
UNDELETE กิจกรรมที่ยกเลิกการลบของผู้ใช้
UPDATE เหตุการณ์การอัปเดตผู้ใช้

OrderBy

Enum
EMAIL อีเมลหลักของผู้ใช้
FAMILY_NAME นามสกุลของผู้ใช้
GIVEN_NAME ชื่อของผู้ใช้

การฉายภาพ

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

SortOrder

Enum
ASCENDING ลำดับจากน้อยไปมาก
DESCENDING ลำดับจากมากไปน้อย

ViewType

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