Method: roleAssignments.list
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
ดึงข้อมูลรายการ roleAssignments ทั้งหมดแบบแบ่งหน้า
คำขอ HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roleassignments
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
| พารามิเตอร์ |
customer |
string
รหัสที่ไม่ซ้ำกันสำหรับบัญชี Google Workspace ของลูกค้า ในกรณีที่เป็นบัญชีหลายโดเมน หากต้องการดึงข้อมูลกลุ่มทั้งหมดสำหรับลูกค้า ให้ใช้ช่องนี้แทน domain นอกจากนี้ คุณยังใช้ชื่อแทน my_customer เพื่อแสดง customerId ของบัญชีได้ด้วย ระบบจะแสดง customerId เป็นส่วนหนึ่งของทรัพยากร Users ด้วย คุณต้องระบุพารามิเตอร์ customer หรือ domain
|
พารามิเตอร์การค้นหา
| พารามิเตอร์ |
maxResults |
integer
จำนวนผลลัพธ์สูงสุดที่จะแสดง
|
pageToken |
string
โทเค็นสำหรับระบุหน้าถัดไปในรายการ
|
roleId |
string
รหัสที่เปลี่ยนแปลงไม่ได้ของบทบาท หากรวมอยู่ในคำขอ ระบบจะแสดงเฉพาะการมอบหมายบทบาทที่มีรหัสบทบาทนี้
|
userKey |
string
อีเมลหลัก อีเมลแทน หรือรหัสผู้ใช้หรือรหัสกลุ่มที่ไม่ซ้ำ หากรวมอยู่ในคำขอ ระบบจะแสดงการมอบหมายบทบาทสำหรับผู้ใช้หรือกลุ่มนี้เท่านั้น
|
includeIndirectRoleAssignments |
boolean
เมื่อตั้งค่าเป็น true ระบบจะดึงข้อมูลการมอบหมายบทบาทโดยอ้อม (เช่น การมอบหมายบทบาทผ่านกลุ่ม) ควบคู่ไปกับแบบโดยตรง ค่าเริ่มต้นคือ false คุณต้องระบุ userKey ไม่เช่นนั้นระบบจะไม่รวมการมอบหมายบทบาทโดยอ้อม
|
เนื้อหาของคำขอ
เนื้อหาของคำขอต้องว่างเปล่า
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้
| การแสดง JSON |
{
"kind": string,
"etag": string,
"items": [
{
object (RoleAssignment)
}
],
"nextPageToken": string
} |
| ช่อง |
kind |
string
ประเภทของทรัพยากร API ค่านี้จะมีค่าเป็น admin#directory#roleAssignments เสมอ
|
etag |
string
ETag ของทรัพยากร
|
items[] |
object (RoleAssignment)
รายการทรัพยากร RoleAssignment
|
nextPageToken |
string
|
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/admin.directory.rolemanagement
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly
ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-25 UTC
[null,null,["อัปเดตล่าสุด 2025-07-25 UTC"],[],[],null,["# Method: roleAssignments.list\n\nRetrieves a paginated list of all roleAssignments.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roleassignments`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customer` | `string` The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](https://developers.google.com/workspace/admin/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter. |\n\n### Query parameters\n\n| Parameters ||\n|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `maxResults` | `integer` Maximum number of results to return. |\n| `pageToken` | `string` Token to specify the next page in the list. |\n| `roleId` | `string` Immutable ID of a role. If included in the request, returns only role assignments containing this role ID. |\n| `userKey` | `string` The primary email address, alias email address, or unique user or group ID. If included in the request, returns role assignments only for this user or group. |\n| `includeIndirectRoleAssignments` | `boolean` When set to `true`, fetches indirect role assignments (i.e. role assignment via a group) as well as direct ones. Defaults to `false`. You must specify `userKey` or the indirect role assignments will not be included. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"items\": [ { object (/workspace/admin/directory/reference/rest/v1/roleAssignments#RoleAssignment) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the API resource. This is always `admin#directory#roleAssignments`. |\n| `etag` | `string` ETag of the resource. |\n| `items[]` | `object (`[RoleAssignment](/workspace/admin/directory/reference/rest/v1/roleAssignments#RoleAssignment)`)` A list of RoleAssignment resources. |\n| `nextPageToken` | `string` |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.rolemanagement`\n- `\n https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
