Method: roles.list
संग्रह की मदद से व्यवस्थित रहें
अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.
किसी डोमेन में सभी भूमिकाओं की पेज की गई सूची दिखाता है.
एचटीटीपी अनुरोध
GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roles
यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.
पाथ पैरामीटर
पैरामीटर |
customer |
string
ग्राहक के Google Workspace खाते का यूनीक आईडी. एक से ज़्यादा डोमेन वाले खाते के मामले में, किसी ग्राहक के सभी ग्रुप फ़ेच करने के लिए, domain के बजाय इस फ़ील्ड का इस्तेमाल करें. अपने खाते के customerId को दिखाने के लिए, my_customer उपनाम का भी इस्तेमाल किया जा सकता है. customerId को उपयोगकर्ता संसाधन के हिस्से के तौर पर भी दिखाया जाता है. आपको customer या domain पैरामीटर में से कोई एक देना होगा.
|
क्वेरी पैरामीटर
पैरामीटर |
maxResults |
integer
कितने नतीजे दिखाने हैं.
|
pageToken |
string
सूची में अगले पेज की जानकारी देने वाला टोकन.
|
अनुरोध का मुख्य भाग
अनुरोध का मुख्य हिस्सा खाली होना चाहिए.
जवाब का मुख्य भाग
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
JSON के काेड में दिखाना |
{
"kind": string,
"etag": string,
"items": [
{
object (Role )
}
],
"nextPageToken": string
} |
फ़ील्ड |
kind |
string
एपीआई रिसॉर्स का टाइप. यह हमेशा admin#directory#roles होती है.
|
etag |
string
संसाधन का ETag.
|
items[] |
object (Role )
भूमिका के संसाधनों की सूची.
|
nextPageToken |
string
|
अनुमति के दायरे
इसके लिए, OAuth के इनमें से किसी एक स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/admin.directory.rolemanagement
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly
ज़्यादा जानकारी के लिए, अनुमति से जुड़ी गाइड देखें.
जब तक कुछ अलग से न बताया जाए, तब तक इस पेज की सामग्री को Creative Commons Attribution 4.0 License के तहत और कोड के नमूनों को Apache 2.0 License के तहत लाइसेंस मिला है. ज़्यादा जानकारी के लिए, Google Developers साइट नीतियां देखें. Oracle और/या इससे जुड़ी हुई कंपनियों का, Java एक रजिस्टर किया हुआ ट्रेडमार्क है.
आखिरी बार 2025-07-25 (UTC) को अपडेट किया गया.
[null,null,["आखिरी बार 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)."]]