Method: users.list

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

คำขอ HTTP

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

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

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

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

string

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

string

รหัสที่ไม่ซ้ํากันสําหรับบัญชี Google Workspace ของลูกค้า ในกรณีที่มีบัญชีหลายโดเมน ให้ใช้ช่องนี้เพื่อดึงข้อมูลกลุ่มทั้งหมดของลูกค้าแทน domain คุณยังสามารถใช้ชื่อแทน my_customer เพื่อแสดงถึง customerId ของบัญชีของคุณได้ด้วย ระบบจะแสดงผล customerId ซึ่งเป็นส่วนหนึ่งของทรัพยากร ผู้ใช้ ด้วยเช่นกัน คุณต้องระบุพารามิเตอร์ 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

เหตุการณ์ที่ทริกเกอร์การตอบกลับนี้ (ใช้เฉพาะในกรณีที่เป็นการตอบกลับแบบพุช)
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 กิจกรรมที่ผู้ใช้อัปเดต

เรียงลําดับตาม

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

การคาดคะเน

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

SortOrder

Enum
ASCENDING เรียงจากน้อยไปมาก
DESCENDING เรียงลําดับจากมากไปน้อย

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

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