Method: roleAssignments.list
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Ruft eine paginaierte Liste aller Rollenzuweisungen ab.
HTTP-Anfrage
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roleassignments
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter |
customer |
string
Die eindeutige ID für das Google Workspace-Konto des Kunden. Wenn Sie bei einem mehrdomänenfähigen Konto alle Gruppen für einen Kunden abrufen möchten, verwenden Sie dieses Feld anstelle von domain . Sie können auch den Alias my_customer verwenden, um die customerId Ihres Kontos zu repräsentieren. Die customerId wird auch als Teil der Ressource Nutzer zurückgegeben. Sie müssen entweder den Parameter customer oder den Parameter domain angeben.
|
Abfrageparameter
Parameter |
maxResults |
integer
Maximale Anzahl der zurückzugebenden Ergebnisse.
|
pageToken |
string
Token, mit dem die nächste Seite in der Liste angegeben wird.
|
roleId |
string
Unveränderliche ID einer Rolle. Wenn diese ID in der Anfrage enthalten ist, werden nur Rollenzuweisungen zurückgegeben, die diese Rollen-ID enthalten.
|
userKey |
string
Die primäre E-Mail-Adresse, Alias-E-Mail-Adresse oder eindeutige Nutzer- oder Gruppen-ID. Wenn dieser Parameter in der Anfrage enthalten ist, werden nur Rollenzuweisungen für diesen Nutzer oder diese Gruppe zurückgegeben.
|
includeIndirectRoleAssignments |
boolean
Wenn diese Option auf true festgelegt ist, werden sowohl indirekte Rollenzuweisungen (d.h. Rollenzuweisungen über eine Gruppe) als auch direkte Rollenzuweisungen abgerufen. Die Standardeinstellung ist false . Sie müssen userKey angeben, da andernfalls die indirekten Rollenzuweisungen nicht berücksichtigt werden.
|
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:
JSON-Darstellung |
{
"kind": string,
"etag": string,
"items": [
{
object (RoleAssignment )
}
],
"nextPageToken": string
} |
Felder |
kind |
string
Der Typ der API-Ressource. Dies ist immer admin#directory#roleAssignments .
|
etag |
string
ETag der Ressource.
|
items[] |
object (RoleAssignment )
Eine Liste von Ressourcen vom Typ „RoleAssignment“.
|
nextPageToken |
string
|
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/admin.directory.rolemanagement
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly
Weitere Informationen finden Sie im Leitfaden zur Autorisierung.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-25 (UTC).
[null,null,["Zuletzt aktualisiert: 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)."]]