Method: roleAssignments.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 todas as roleAssignments.
Solicitação HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roleassignments
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 .
|
Parâmetros de consulta
Parâmetros |
maxResults |
integer
Número máximo de resultados a serem retornados.
|
pageToken |
string
Token para especificar a próxima página na lista.
|
roleId |
string
ID imutável de uma função. Se incluído na solicitação, retorna apenas as atribuições de função que contêm esse ID de função.
|
userKey |
string
É o endereço de e-mail principal, o endereço de e-mail de alias ou o ID exclusivo do usuário ou grupo. Se incluído na solicitação, retorna atribuições de função apenas para esse usuário ou grupo.
|
includeIndirectRoleAssignments |
boolean
Quando definido como true , busca atribuições de função indiretas (ou seja, atribuição de função por um grupo) e diretas. O padrão é false . É necessário especificar userKey , ou as atribuições de função indiretas não serão incluídas.
|
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 (RoleAssignment )
}
],
"nextPageToken": string
} |
Campos |
kind |
string
O tipo do recurso da API. Isso é sempre admin#directory#roleAssignments .
|
etag |
string
ETag do recurso.
|
items[] |
object (RoleAssignment )
Uma lista de recursos de RoleAssignment.
|
nextPageToken |
string
|
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.
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: 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)."]]