Method: roles.list

ดึงข้อมูลรายการบทบาททั้งหมดในโดเมนแบบแบ่งหน้า

คำขอ HTTP

GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roles

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

พารามิเตอร์เส้นทาง

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

string

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

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

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

integer

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

string

โทเค็นสำหรับระบุหน้าถัดไปในรายการ

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

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

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

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

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

string

ประเภทของทรัพยากร API ค่านี้จะมีค่าเป็น admin#directory#roles เสมอ
etag

string

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

object (Role)

รายการแหล่งข้อมูลบทบาท
nextPageToken

string

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

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/admin.directory.rolemanagement
  • https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly

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