Method: privileges.list
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recupera uma lista paginada de todos os privilégios de um cliente.
Solicitação HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roles/ALL/privileges
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros |
customer |
string
O ID exclusivo da conta do Google Workspace do cliente. No caso de uma conta com vários domínios, para buscar todos os grupos de um cliente, use esse campo em vez de domain . Também é possível usar o alias my_customer para representar o customerId da sua conta. O customerId também é retornado como parte do recurso Users. Forneça o parâmetro customer ou domain .
|
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:
Representação JSON |
{
"kind": string,
"etag": string,
"items": [
{
object (Privilege )
}
]
} |
Campos |
kind |
string
O tipo do recurso da API. Isso é sempre admin#directory#privileges .
|
etag |
string
ETag do recurso.
|
items[] |
object (Privilege )
Uma lista de recursos de privilégio.
|
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
https://www.googleapis.com/auth/admin.directory.rolemanagement
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly
Para mais informações, consulte o guia de autorização.
Privilégio
Representação JSON |
{
"serviceId": string,
"kind": string,
"etag": string,
"isOuScopable": boolean,
"childPrivileges": [
{
object (Privilege )
}
],
"privilegeName": string,
"serviceName": string
} |
Campos |
serviceId |
string
O ID ofuscado do serviço a que esse privilégio se destina. Esse valor é retornado com Privileges.list() .
|
kind |
string
O tipo do recurso da API. Isso é sempre admin#directory#privilege .
|
etag |
string
ETag do recurso.
|
isOuScopable |
boolean
Se o privilégio pode ser restrito a uma unidade organizacional.
|
childPrivileges[] |
object (Privilege )
Uma lista de privilégios filhos. Os privilégios de um serviço formam uma árvore. Cada privilégio pode ter uma lista de privilégios filhos. Essa lista fica vazia para um privilégio de folha.
|
privilegeName |
string
O nome do privilégio.
|
serviceName |
string
O nome do serviço a que este privilégio se destina.
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-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. |"]]