Method: roles.list
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Récupère une liste paginée de tous les rôles d'un domaine.
Requête HTTP
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roles
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
customer |
string
Identifiant unique du compte Google Workspace du client. Dans le cas d'un compte multidomaine, pour récupérer tous les groupes d'un client, utilisez ce champ au lieu de domain. Vous pouvez également utiliser l'alias my_customer pour représenter le customerId de votre compte. customerId est également renvoyé dans la ressource Users (Utilisateurs). Vous devez fournir le paramètre customer ou domain.
|
Paramètres de requête
| Paramètres |
maxResults |
integer
Nombre maximal de résultats sur une page.
|
pageToken |
string
Jeton permettant de spécifier la page suivante de la liste.
|
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :
| Représentation JSON |
{
"kind": string,
"etag": string,
"items": [
{
object (Role)
}
],
"nextPageToken": string
} |
| Champs |
kind |
string
Type de la ressource d'API. Cette valeur est toujours admin#directory#roles.
|
etag |
string
ETag de la ressource.
|
items[] |
object (Role)
Liste des ressources de rôle.
|
nextPageToken |
string
|
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/admin.directory.rolemanagement
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly
Pour en savoir plus, consultez le guide d'autorisation.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[],[],null,["# Method: roles.list\n\nRetrieves a paginated list of all the roles in a domain.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roles`\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\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/roles#Role) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the API resource. This is always `admin#directory#roles`. |\n| `etag` | `string` ETag of the resource. |\n| `items[]` | `object (`[Role](/workspace/admin/directory/reference/rest/v1/roles#Role)`)` A list of Role 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)."]]
