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

सूची में अगला पेज दिखाने के लिए टोकन.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Role)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
kind

string

एपीआई संसाधन का टाइप. यह हमेशा admin#directory#roles होता है.
etag

string

संसाधन का ईटैग.
items[]

object (Role)

भूमिका से जुड़े संसाधनों की सूची.
nextPageToken

string

अनुमति देने के दायरे

इनमें से कोई एक OAuth स्कोप ज़रूरी है:

  • https://www.googleapis.com/auth/admin.directory.rolemanagement
  • https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.