Method: privileges.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a paginated list of all privileges for a customer.
HTTP request
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roles/ALL/privileges
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
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 resource. You must provide either the customer or the domain parameter.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"kind": string,
"etag": string,
"items": [
{
object (Privilege)
}
]
} |
| Fields |
kind |
string
The type of the API resource. This is always admin#directory#privileges.
|
etag |
string
ETag of the resource.
|
items[] |
object (Privilege)
A list of Privilege resources.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/admin.directory.rolemanagement
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly
For more information, see the Authorization guide.
Privilege
| JSON representation |
{
"serviceId": string,
"kind": string,
"etag": string,
"isOuScopable": boolean,
"childPrivileges": [
{
object (Privilege)
}
],
"privilegeName": string,
"serviceName": string
} |
| Fields |
serviceId |
string
The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list().
|
kind |
string
The type of the API resource. This is always admin#directory#privilege.
|
etag |
string
ETag of the resource.
|
isOuScopable |
boolean
If the privilege can be restricted to an organization unit.
|
childPrivileges[] |
object (Privilege)
A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege.
|
privilegeName |
string
The name of the privilege.
|
serviceName |
string
The name of the service this privilege is for.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Method: privileges.list\n\nRetrieves a paginated list of all privileges for a customer.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roles/ALL/privileges`\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### 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/privileges/list#Privilege) } ] } ``` |\n\n| Fields ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the API resource. This is always `admin#directory#privileges`. |\n| `etag` | `string` ETag of the resource. |\n| `items[]` | `object (`[Privilege](/workspace/admin/directory/reference/rest/v1/privileges/list#Privilege)`)` A list of Privilege resources. |\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).\n\nPrivilege\n---------\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"serviceId\": string, \"kind\": string, \"etag\": string, \"isOuScopable\": boolean, \"childPrivileges\": [ { object (/workspace/admin/directory/reference/rest/v1/privileges/list#Privilege) } ], \"privilegeName\": string, \"serviceName\": string } ``` |\n\n| Fields ||\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `serviceId` | `string` The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list). |\n| `kind` | `string` The type of the API resource. This is always `admin#directory#privilege`. |\n| `etag` | `string` ETag of the resource. |\n| `isOuScopable` | `boolean` If the privilege can be restricted to an organization unit. |\n| `childPrivileges[]` | `object (`[Privilege](/workspace/admin/directory/reference/rest/v1/privileges/list#Privilege)`)` A list of child privileges. Privileges for a service form a tree. Each privilege can have a list of child privileges; this list is empty for a leaf privilege. |\n| `privilegeName` | `string` The name of the privilege. |\n| `serviceName` | `string` The name of the service this privilege is for. |"]]
