Method: groups.list

Truy xuất tất cả các nhóm của một miền hoặc của một người dùng đã cấp một khoá người dùng (đã phân trang).

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Các tham số
customer

string

Mã nhận dạng duy nhất cho tài khoản Google Workspace của khách hàng. Đối với tài khoản nhiều miền, để tìm nạp tất cả các nhóm cho khách hàng, hãy sử dụng trường này thay cho domain. Bạn cũng có thể sử dụng bí danh my_customer để đại diện cho customerId của tài khoản. customerId cũng được trả về như một phần của tài nguyên Người dùng. Bạn phải cung cấp tham số customer hoặc domain.
domain

string

Tên miền. Sử dụng trường này để nhận các nhóm chỉ từ một miền. Để trả về tất cả miền cho một tài khoản khách hàng, hãy sử dụng tham số truy vấn customer.
maxResults

integer

Số lượng kết quả tối đa cần trả về. Giá trị tối đa cho phép là 200.
orderBy

enum (OrderBy)

Cột dùng để sắp xếp kết quả
pageToken

string

Mã thông báo để chỉ định trang tiếp theo trong danh sách
query

string

Tìm kiếm chuỗi truy vấn. Phải có dạng "". Tài liệu đầy đủ có tại https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

Liệu trả về kết quả theo thứ tự tăng dần hay giảm dần. Chỉ sử dụng khi orderBy cũng được sử dụng
userKey

string

Email hoặc mã không thể thay đổi của người dùng nếu chỉ những nhóm đó được liệt kê thì người dùng đó sẽ là thành viên. Nếu đó là mã nhận dạng, thì mã này phải khớp với mã nhận dạng của đối tượng người dùng.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "kind": string,
  "etag": string,
  "groups": [
    {
      object (Group)
    }
  ],
  "nextPageToken": string
}
Các trường
kind

string

Đây là một loại tài nguyên.
etag

string

ETag của tài nguyên.
groups[]

object (Group)

Danh sách các đối tượng nhóm.
nextPageToken

string

Mã thông báo được dùng để truy cập vào trang tiếp theo của kết quả này.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.readonly

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

OrderBy

Enum
EMAIL Email của nhóm.

SortOrder

Enum
ASCENDING Thứ tự tăng dần.
DESCENDING Thứ tự giảm dần.