Method: roles.list

擷取網域中所有角色的分頁清單。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
customer

string

客戶 Google Workspace 帳戶的專屬 ID。在多網域帳戶的情況下，如要擷取客戶的所有群組，請使用這個欄位，而不是 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

詳情請參閱授權指南。