REST Resource: users

संसाधन: उपयोगकर्ता

डायरेक्ट्री एपीआई की मदद से, अपने खाते के उपयोगकर्ताओं, उपयोगकर्ताओं के उपनाम, और उपयोगकर्ता की Google प्रोफ़ाइल फ़ोटो बनाई जा सकती हैं. साथ ही, उन्हें मैनेज किया जा सकता है. सामान्य टास्क के बारे में ज़्यादा जानकारी के लिए, उपयोगकर्ता खातों के लिए डेवलपर की गाइड और उपयोगकर्ता के उपनाम वाले डेवलपर की गाइड देखें.

जेएसओएन के काेड में दिखाना
{
  "id": string,
  "primaryEmail": string,
  "password": value,
  "hashFunction": string,
  "isAdmin": boolean,
  "isDelegatedAdmin": boolean,
  "agreedToTerms": boolean,
  "suspended": boolean,
  "changePasswordAtNextLogin": boolean,
  "ipWhitelisted": boolean,
  "name": {
    object (UserName)
  },
  "kind": string,
  "etag": string,
  "emails": value,
  "externalIds": value,
  "relations": value,
  "aliases": [
    string
  ],
  "isMailboxSetup": boolean,
  "customerId": string,
  "addresses": value,
  "organizations": value,
  "lastLoginTime": string,
  "phones": value,
  "suspensionReason": string,
  "thumbnailPhotoUrl": string,
  "languages": value,
  "posixAccounts": value,
  "creationTime": string,
  "nonEditableAliases": [
    string
  ],
  "sshPublicKeys": value,
  "notes": value,
  "websites": value,
  "locations": value,
  "includeInGlobalAddressList": boolean,
  "keywords": value,
  "deletionTime": string,
  "gender": value,
  "thumbnailPhotoEtag": string,
  "ims": value,
  "customSchemas": value,
  "isEnrolledIn2Sv": boolean,
  "isEnforcedIn2Sv": boolean,
  "archived": boolean,
  "orgUnitPath": string,
  "recoveryEmail": string,
  "recoveryPhone": string
}
फ़ील्ड
id

string

उपयोगकर्ता के लिए यूनीक आईडी. उपयोगकर्ता id का इस्तेमाल, उपयोगकर्ता के अनुरोध के यूआरआई की userKey के तौर पर किया जा सकता है.

primaryEmail

string

उपयोगकर्ता का मुख्य ईमेल पता. उपयोगकर्ता खाता बनाने के अनुरोध के लिए, यह प्रॉपर्टी ज़रूरी है. primaryEmail सबसे अलग होना चाहिए और किसी दूसरे उपयोगकर्ता का उपनाम नहीं होना चाहिए.

password

value (Value format)

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

पासवर्ड में ASCII वर्णों का कोई भी संयोजन हो सकता है और यह 8 से 100 वर्णों के बीच होना चाहिए.

हमारा सुझाव है कि आप password पैरामीटर को, हेक्साडेसिमल कोड वाली हैश वैल्यू के तौर पर भेजें और उसके हिसाब से hashFunction सेट करें. अगर hashFunction दिया गया है, तो पासवर्ड एक मान्य हैश कुंजी होना चाहिए.

hashFunction

string

password प्रॉपर्टी का हैश फ़ॉर्मैट सेव करता है. ये hashFunction वैल्यू इस्तेमाल की जा सकती हैं:

  • MD5 - हेक्स कोड में बदली गई सामान्य वैल्यू को स्वीकार करता है.
  • SHA-1 - हेक्स कोड में बदली गई सामान्य वैल्यू को स्वीकार करता है.
  • crypt - C क्रिप्ट लाइब्रेरी के मुताबिक है. DES, MD5 (हैश प्रीफ़िक्स $1$), SHA-256 (हैश प्रीफ़िक्स $5$), और SHA-512 (हैश प्रीफ़िक्स $6$) हैश एल्गोरिदम के साथ काम करता है.

अगर राउंड को प्रीफ़िक्स के हिस्से के तौर पर बताया गया है, तो वे 10,000 या उससे कम होने चाहिए.

isAdmin

boolean

सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि किसी उपयोगकर्ता को सुपर एडमिन के खास अधिकार हैं. isAdmin प्रॉपर्टी में बदलाव सिर्फ़ किसी उपयोगकर्ता को एडमिन बनाएं कार्रवाई ( makeAdmin तरीका) में किया जा सकता है. अगर उपयोगकर्ता के शामिल करने या अपडेट करने के तरीके में बदलाव किया गया है, तो एपीआई सेवा उन बदलावों को अनदेखा कर देती है.

isDelegatedAdmin

boolean

सिर्फ़ आउटपुट के लिए. इससे पता चलता है कि उपयोगकर्ता को डेलीगेटेड एडमिन (जिस व्यक्ति को एडमिन खाते का ऐक्सेस दिया गया हो) है.
जिस एडमिन को ऐक्सेस दिया गया हो वह एपीआई के साथ काम करता है. हालांकि, वे उपयोगकर्ताओं को बना या मिटा नहीं सकते. इसके अलावा, वे उपयोगकर्ताओं को एडमिन नहीं बना सकते. इन अनुरोधों को एपीआई सेवा अनदेखा कर देती है.
एडमिन को भूमिकाएं और खास अधिकार Admin console का इस्तेमाल करके असाइन किए जाते हैं.

agreedToTerms

boolean

सिर्फ़ आउटपुट के लिए. अगर उपयोगकर्ता ने शुरुआत में लॉगिन किया है और सेवा की शर्तों का कानूनी समझौता स्वीकार किया है, तो इस प्रॉपर्टी का नाम true है.

suspended

boolean

यह बताता है कि उपयोगकर्ता को निलंबित किया गया है या नहीं.

changePasswordAtNextLogin

boolean

इससे पता चलता है कि अगली बार लॉगिन करने पर, उपयोगकर्ता को अपना पासवर्ड बदलना पड़ेगा या नहीं. जब उपयोगकर्ता किसी तीसरे पक्ष के आइडेंटिटी प्रोवाइडर से साइन इन करता है, तो यह सेटिंग लागू नहीं होती.

ipWhitelisted

boolean

अगर true हो, तो उपयोगकर्ता का आईपी पता ऐसे आईपी पते allowlist कॉन्फ़िगरेशन के मुताबिक होगा जो अब काम नहीं करता.

name

object (UserName)

इसमें उपयोगकर्ता के दिए गए और परिवार के नाम और रीड-ओनली fullName वैल्यू होती है. givenName और familyName वैल्यू में, ज़्यादा से ज़्यादा 60 वर्ण इस्तेमाल किए जा सकते हैं. नाम की वैल्यू, यूनिकोड/UTF-8 वर्णों के साथ काम करती हैं. इनमें स्पेस, अक्षर (a-z), संख्याएं (0-9), डैश (-), फ़ॉरवर्ड स्लैश (/), और पीरियड (.) भी हो सकते हैं. वर्ण के इस्तेमाल के नियमों के बारे में ज़्यादा जानने के लिए, एडमिन सहायता केंद्र पर जाएं. इस फ़ील्ड के लिए, डेटा साइज़ 1 केबी ही हो सकता है.

kind

string

सिर्फ़ आउटपुट के लिए. एपीआई संसाधन का टाइप. उपयोगकर्ता के संसाधनों के लिए, वैल्यू admin#directory#user है.

etag

string

सिर्फ़ आउटपुट के लिए. संसाधन का ईटैग.

emails

value (Value format)

उपयोगकर्ता के ईमेल पतों की सूची. डेटा का साइज़ 10 केबी से ज़्यादा नहीं होना चाहिए.

फ़ील्ड

emails[].address

string

उपयोगकर्ता का ईमेल पता. ईमेल आईडी के तौर पर भी काम करता है. यह वैल्यू, उपयोगकर्ता का मुख्य ईमेल पता या कोई उपनाम हो सकता है.

emails[].customType

string

अगर ईमेल पता type custom है, तो इस प्रॉपर्टी में कस्टम वैल्यू शामिल होती है और इसे सेट करना ज़रूरी है.

emails[].primary

boolean

इससे पता चलता है कि यह उपयोगकर्ता का मुख्य ईमेल पता है या नहीं. सिर्फ़ एक एंट्री को मुख्य के तौर पर मार्क किया जा सकता है.

emails[].type

string

ईमेल खाता किस तरह का है. अगर इस नीति को custom पर सेट किया जाता है, तो customType भी सेट होना चाहिए.

ये वैल्यू दी जा सकती हैं: custom, home, other, work.

externalIds

value (Value format)

उपयोगकर्ता के लिए बाहरी आईडी की सूची, जैसे कि कोई कर्मचारी या नेटवर्क आईडी. डेटा का साइज़ 2 केबी से ज़्यादा नहीं होना चाहिए.

फ़ील्ड

externalIds[].customType

string

अगर बाहरी आईडी type custom है, तो इस प्रॉपर्टी में कस्टम वैल्यू शामिल होती है और इसे सेट करना ज़रूरी है.

externalIds[].type

string

बाहरी आईडी का टाइप. अगर इस नीति को custom पर सेट किया जाता है, तो customType भी सेट होना चाहिए.

ये वैल्यू दी जा सकती हैं: account, custom, customer, login_id, network, organization.

externalIds[].value

string

बाहरी आईडी की वैल्यू.

relations

value (Value format)

अन्य उपयोगकर्ताओं के साथ उपयोगकर्ता के संबंधों की सूची. इस फ़ील्ड के लिए, ज़्यादा से ज़्यादा 2 केबी डेटा साइज़ की अनुमति है. ज़्यादा जानकारी के लिए, उपयोगकर्ता खाते मैनेज करना लेख पढ़ें.

फ़ील्ड

relations[].customType

string

अगर type, custom है, तो इस प्रॉपर्टी में कस्टम वैल्यू शामिल होती है और इसे सेट करना ज़रूरी है.

relations[].type

string

संबंध किस तरह का है. अगर इस नीति को custom पर सेट किया जाता है, तो customType भी सेट होनी चाहिए.

स्वीकार की जाने वाली वैल्यू:
  • admin_assistant
  • assistant
  • brother
  • child
  • custom
  • domestic_partner
  • dotted_line_manager
  • exec_assistant
  • father
  • friend
  • manager
  • mother
  • parent
  • partner
  • referred_by
  • relative
  • sister
  • spouse

relations[].value

string

उस व्यक्ति का ईमेल पता जिससे उपयोगकर्ता जुड़ा है.

aliases[]

string

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता के उपनाम वाले ईमेल पतों की सूची.

isMailboxSetup

boolean

सिर्फ़ आउटपुट के लिए. यह बताता है कि उपयोगकर्ता का Google मेलबॉक्स बनाया गया है या नहीं. यह प्रॉपर्टी सिर्फ़ तब लागू होती है, जब उपयोगकर्ता को Gmail का लाइसेंस असाइन किया गया हो.

customerId

string

सिर्फ़ आउटपुट के लिए. सभी खाता उपयोगकर्ताओं को वापस लाने के लिए ग्राहक आईडी.
अपने खाते का customerId दिखाने के लिए, आप उपनाम my_customer का इस्तेमाल कर सकते हैं.
रीसेलर एडमिन के तौर पर, आप रीसेलर से खरीदने वाले ग्राहक के खाते के customerId का इस्तेमाल कर सकते हैं. customerId पाने के लिए, users.list से जुड़ी अनुरोध के domain पैरामीटर में, खाते के प्राइमरी डोमेन का इस्तेमाल करें.

addresses

value (Value format)

उपयोगकर्ता के पतों की सूची. डेटा का साइज़ 10 केबी से ज़्यादा नहीं होना चाहिए.

फ़ील्ड

addresses[].country

string

देश.

addresses[].countryCode

string

देश का कोड. ISO 3166-1 स्टैंडर्ड का इस्तेमाल किया जाता है.

addresses[].customType

string

अगर type पता custom है, तो इस प्रॉपर्टी में कस्टम वैल्यू शामिल होती है और इसे सेट करना ज़रूरी है.

addresses[].extendedAddress

string

बड़े पतों के लिए, जैसे कि उप-क्षेत्र वाला कोई पता.

addresses[].formatted

string

पूरा और बिना स्ट्रक्चर वाला डाक पता. इसे स्ट्रक्चर्ड पते के फ़ील्ड के साथ सिंक नहीं किया जाता है. इसमें ये एट्रिब्यूट शामिल होते हैं: मोहल्ले का पता, पीओ बॉक्स, शहर, राज्य/प्रांत, पिन कोड, देश/इलाका.

addresses[].locality

string

पते का कस्बा या शहर.

addresses[].poBox

string

अगर पोस्ट ऑफ़िस बॉक्स मौजूद है, तो उसे.

addresses[].postalCode

string

ज़िप या पिन कोड, अगर लागू हो.

addresses[].primary

boolean

अगर यह उपयोगकर्ता का मुख्य पता है. पते की सूची में सिर्फ़ एक मुख्य पता हो सकता है.

addresses[].region

string

संक्षिप्त प्रांत या राज्य.

addresses[].sourceIsStructured

boolean

यह बताता है कि उपयोगकर्ता से मिला पता फ़ॉर्मैट किया गया था या नहीं. फ़िलहाल, फ़ॉर्मैट किए गए पते इस्तेमाल नहीं किए जा सकते.

addresses[].streetAddress

string

मोहल्ले का पता, जैसे कि 1600 Amphitheatre Parkway. स्ट्रिंग के अंदर खाली जगह को अनदेखा कर दिया जाता है. हालांकि, नई लाइनें अहम होती हैं.

addresses[].type

string

पते का टाइप. अगर इस नीति को custom पर सेट किया जाता है, तो customType भी सेट होना चाहिए.

ये वैल्यू दी जा सकती हैं: custom, home, other, work.

organizations

value (Value format)

उन संगठनों की सूची जिनका उपयोगकर्ता है. डेटा का साइज़ 10 केबी से ज़्यादा नहीं होना चाहिए.

फ़ील्ड

organizations[].costCenter

string

उपयोगकर्ता के संगठन का कॉस्ट सेंटर.

organizations[].customType

string

अगर टाइप की वैल्यू कस्टम है, तो इस प्रॉपर्टी में कस्टम टाइप शामिल होता है.

organizations[].department

string

संगठन के अंदर के डिपार्टमेंट के बारे में बताता है, जैसे कि sales या engineering.

organizations[].description

string

संगठन का ब्यौरा.

organizations[].domain

string

वह डोमेन जिससे संगठन काम करता है.

organizations[].fullTimeEquivalent

integer

संगठन में फ़ुल-टाइम के बराबर मिलीसेकंड (100000 = 100%).

organizations[].location

string

संगठन की जगह की जानकारी. इसके लिए, यह ज़रूरी नहीं है कि यह पता पूरी तरह क्वालिफ़ाइड हो.

organizations[].name

string

संगठन का नाम.

organizations[].primary

boolean

इससे पता चलता है कि यह उपयोगकर्ता का मुख्य संगठन है या नहीं. किसी उपयोगकर्ता का सिर्फ़ एक प्राथमिक संगठन हो सकता है.

organizations[].symbol

string

टेक्स्ट स्ट्रिंग में संगठन का सिंबल. जैसे, Google का टेक्स्ट सिंबल GOOG है.

organizations[].title

string

संगठन के अंदर उपयोगकर्ता का टाइटल. उदाहरण के लिए, member या engineer.

organizations[].type

string

संगठन किस तरह का है.

स्वीकार की जाने वाली वैल्यू: domain_only, school, unknown, work.

lastLoginTime

string

सिर्फ़ आउटपुट के लिए. वह समय जब उपयोगकर्ता ने पिछली बार उपयोगकर्ता के खाते में लॉग इन किया था. वैल्यू, ISO 8601 तारीख और समय के फ़ॉर्मैट में होती है. समय, YYYY-MM-DDThh:mm:ssTZD फ़ॉर्म में पूरी तारीख के साथ घंटे, मिनट, और सेकंड की जानकारी देता है. उदाहरण के लिए, 2010-04-05T17:30:04+01:00.

phones

value (Value format)

उपयोगकर्ता के फ़ोन नंबर की सूची. डेटा का साइज़ 1 केबी से ज़्यादा नहीं होना चाहिए.

फ़ील्ड

phones[].customType

string

अगर फ़ोन नंबर type custom है, तो इस प्रॉपर्टी में कस्टम वैल्यू शामिल होती है और इसे सेट करना ज़रूरी है.

phones[].primary

boolean

अगर true, तो यह उपयोगकर्ता का मुख्य फ़ोन नंबर है. किसी उपयोगकर्ता के पास सिर्फ़ एक मुख्य फ़ोन नंबर हो सकता है.

phones[].type

string

फ़ोन नंबर का टाइप. अगर custom पर सेट किया जाता है, तो customType भी सेट किया जाना चाहिए.

स्वीकार की जाने वाली वैल्यू: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work,
.work_faxwork_mobilework_pager

phones[].value

string

ऐसा फ़ोन नंबर जिसे कोई भी व्यक्ति आसानी से पढ़ सके. यह किसी भी टेलीफ़ोन नंबर फ़ॉर्मैट में हो सकता है.

suspensionReason

string

सिर्फ़ आउटपुट के लिए. वह वजह होती है कि निलंबन के समय किसी उपयोगकर्ता खाते को एडमिन या Google ने निलंबित किया था. प्रॉपर्टी सिर्फ़ तब दिखेगी, जब suspended प्रॉपर्टी true हो.

thumbnailPhotoUrl

string

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता की प्रोफ़ाइल फ़ोटो का यूआरएल. यूआरएल कुछ समय के लिए या निजी हो सकता है.

languages

value (Value format)

उपयोगकर्ता की भाषाओं की सूची. डेटा का साइज़ 1 केबी से ज़्यादा नहीं होना चाहिए.

फ़ील्ड

languages[].customLanguage

string

दूसरी भाषा. अगर उससे जुड़ा कोई ISO 639 भाषा कोड नहीं है, तो उपयोगकर्ता अपनी भाषा का नाम दे सकता है. अगर यह सेट है, तो languageCode को सेट नहीं किया जा सकता.

languages[].languageCode

string

किसी भाषा को ISO 639 स्ट्रिंग दिखाना. इस्तेमाल किए जा सकने वाले कोड की सूची के लिए, भाषा के कोड देखें. काम करने वाले सेट से बाहर के मान्य कोड को एपीआई स्वीकार करेगा. हालांकि, इससे अनचाहा व्यवहार दिख सकता है. गैर-कानूनी वैल्यू की वजह से SchemaException होता है. अगर यह सेट है, तो customLanguage को सेट नहीं किया जा सकता.

languages[].preference

string

ज़रूरी नहीं. इस नीति के मौजूद होने पर, यह कंट्रोल किया जाता है कि बताई गई languageCode, उपयोगकर्ता की पसंदीदा भाषा है या नहीं. अगर customLanguage की वैल्यू सेट की गई है, तो इसे सेट नहीं किया जा सकता. preferred और not_preferred को वैल्यू के तौर पर इस्तेमाल किया जा सकता है.

posixAccounts

value (Value format)

उपयोगकर्ता के लिए POSIX के खाते की जानकारी की सूची.

फ़ील्ड

posixAccounts[].accountId

string

POSIX खाते का फ़ील्ड आइडेंटिफ़ायर.

posixAccounts[].gecos

string

इस खाते के लिए GECOS (उपयोगकर्ता की जानकारी).

posixAccounts[].gid

unsigned long

डिफ़ॉल्ट ग्रुप आईडी.

posixAccounts[].homeDirectory

string

इस खाते की होम डायरेक्ट्री का पाथ.

posixAccounts[].operatingSystemType

string

इस खाते का ऑपरेटिंग सिस्टम किस तरह का है.

स्वीकार की जाने वाली वैल्यू: linux, unspecified, windows.

posixAccounts[].primary

boolean

अगर यह SystemId में उपयोगकर्ता का मुख्य खाता है.

posixAccounts[].shell

string

इस खाते के लिए लॉगिन शेल का पाथ.

posixAccounts[].systemId

string

जिस खाते पर उपयोगकर्ता नाम या यूआईडी लागू होता है उसका सिस्टम आइडेंटिफ़ायर.

posixAccounts[].uid

unsigned long

POSIX का पालन करने वाला यूज़र आईडी.

posixAccounts[].username

string

खाते का उपयोगकर्ता नाम.

creationTime

string

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता का खाता बनाए जाने का समय. वैल्यू, ISO 8601 तारीख और समय के फ़ॉर्मैट में होती है. समय, YYYY-MM-DDThh:mm:ssTZD फ़ॉर्म में पूरी तारीख के साथ घंटे, मिनट, और सेकंड की जानकारी देता है. उदाहरण के लिए, 2010-04-05T17:30:04+01:00.

nonEditableAliases[]

string

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता के ऐसे उपनाम वाले ईमेल पतों की सूची जिनमें बदलाव नहीं किया जा सकता. ये आम तौर पर खाते के प्राइमरी डोमेन या सब-डोमेन से बाहर होते हैं.

sshPublicKeys

value (Value format)

SSH सार्वजनिक कुंजियों की सूची.

फ़ील्ड

sshPublicKeys[].expirationTimeUsec

long

Epoch के बाद से माइक्रोसेकंड में समयसीमा खत्म होने का समय.

sshPublicKeys[].fingerprint

string

SSH सार्वजनिक कुंजी का SHA-256 फ़िंगरप्रिंट. (केवल पढ़ने के लिए)

sshPublicKeys[].key

string

SSH सार्वजनिक कुंजी.

notes

value (Value format)

उपयोगकर्ता के लिए नेस्ट किए गए ऑब्जेक्ट के तौर पर नोट.

फ़ील्ड

notes.contentType

string

नोट का कॉन्टेंट टाइप, या तो सादा टेक्स्ट या एचटीएमएल. डिफ़ॉल्ट तौर पर, यह सादा टेक्स्ट होता है.

स्वीकार की जाने वाली वैल्यू: text_plain, text_html.

notes.value

string

नोट की सामग्री.

websites

value (Value format)

उपयोगकर्ता की वेबसाइटों की सूची.

फ़ील्ड

websites[].customType

string

अगर type वेबसाइट custom है, तो इस प्रॉपर्टी में कस्टम वैल्यू शामिल होती है और इसे सेट करना ज़रूरी है.

websites[].primary

boolean

अगर true है, तो यह उपयोगकर्ता की मुख्य वेबसाइट है.

websites[].type

string

वेबसाइट का टाइप या मकसद. उदाहरण के लिए, किसी वेबसाइट को home या blog के तौर पर लेबल किया जा सकता है. इसके अलावा, एंट्री में custom टाइप भी हो सकता है. अगर यह वैल्यू custom पर सेट है, तो customType भी सेट होनी चाहिए.

ये वैल्यू दी जा सकती हैं: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work.

websites[].value

string

वेबसाइट का यूआरएल.

locations

value (Value format)

उपयोगकर्ता की जगहों की सूची. डेटा का साइज़ 10 केबी से ज़्यादा नहीं होना चाहिए.

फ़ील्ड

locations[].area

string

टेक्स्ट वाली जगह. यह जगह की कम शब्दों में जानकारी देने के मकसद से सबसे ज़्यादा काम आता है. उदाहरण के लिए, Mountain View, CA या Near Seattle.

locations[].buildingId

string

बिल्डिंग का आइडेंटिफ़ायर.

locations[].customType

string

अगर जगह के तौर पर type, custom है, तो इस प्रॉपर्टी में कस्टम वैल्यू शामिल होती है. इसे सेट करना ज़रूरी है.

locations[].deskCode

string

हर डेस्क की जगह के बारे में टेक्स्ट वाला सबसे खास कोड.

locations[].floorName

string

फ़्लोर का नाम/नंबर.

locations[].floorSection

string

फ़्लोर का सेक्शन. फ़्लोर में ज़्यादा सटीक जगह. उदाहरण के लिए, अगर किसी मंज़िल को A, B, और C सेक्शन में बांटा गया है, तो यह फ़ील्ड उनमें से किसी एक वैल्यू की पहचान करेगा.

locations[].type

string

जगह का टाइप. अगर इस नीति को custom पर सेट किया जाता है, तो customType भी सेट होना चाहिए.

ये वैल्यू दी जा सकती हैं: custom, default, desk.

includeInGlobalAddressList

boolean

इससे पता चलता है कि डोमेन के लिए संपर्क शेयर करने की सुविधा चालू होने पर, उपयोगकर्ता की प्रोफ़ाइल, Google Workspace की ग्लोबल पता सूची में दिखती है या नहीं. उपयोगकर्ता की प्रोफ़ाइलों को बाहर रखने के बारे में ज़्यादा जानकारी के लिए, एडमिन सहायता केंद्र पर जाएं.

keywords

value (Value format)

उपयोगकर्ता के कीवर्ड की सूची. डेटा का साइज़ 1 केबी से ज़्यादा नहीं होना चाहिए.

फ़ील्ड

keywords[].customType

string

अगर type कीवर्ड custom है, तो इस प्रॉपर्टी में कस्टम वैल्यू शामिल है और इसे सेट किया जाना चाहिए.

keywords[].type

string

हर एंट्री में एक ऐसा टाइप हो सकता है जो उस एंट्री का स्टैंडर्ड टाइप बताता है.

उदाहरण के लिए, कीवर्ड occupation या outlook टाइप का हो सकता है. स्टैंडर्ड टाइप के अलावा, एंट्री में custom टाइप हो सकता है और उसे कोई भी नाम दिया जा सकता है. अगर इस नीति को custom पर सेट किया जाता है, तो customType भी सेट होना चाहिए.

ये वैल्यू दी जा सकती हैं: custom, mission, occupation, outlook.

keywords[].value

string

कीवर्ड.

deletionTime

string

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता का खाता मिटाए जाने का समय. वैल्यू, ISO 8601 तारीख और समय के फ़ॉर्मैट में होती है. समय, YYYY-MM-DDThh:mm:ssTZD फ़ॉर्म में पूरी तारीख के साथ घंटे, मिनट, और सेकंड की जानकारी देता है. उदाहरण के लिए, 2010-04-05T17:30:04+01:00.

gender

value (Value format)

नेस्ट किया गया एक ऑब्जेक्ट, जिसमें उपयोगकर्ता के लिंग की जानकारी होती है. इस फ़ील्ड के लिए, डेटा साइज़ 1 केबी ही हो सकता है.

फ़ील्ड

gender.addressMeAs

string

इस स्ट्रिंग में किसी व्यक्ति को प्रोफ़ाइल के मालिक के बारे में बताने का सही तरीका दिया गया होता है. उदाहरण के लिए, "वह/उसकी/उनकी" या "वे/उन्हें/उनके".

gender.customGender

string

पसंद के मुताबिक लिंग का नाम.

gender.type

string

लिंग किस तरह का है.

स्वीकार किए जाने वाले वैल्यू:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता की फ़ोटो का ई-टैग (सिर्फ़ पढ़ने के लिए)

ims

value (Value format)

उपयोगकर्ता के इंस्टैंट मैसेंजर (IM) खाते. किसी उपयोगकर्ता खाते में एक से ज़्यादा ims प्रॉपर्टी हो सकती हैं, लेकिन इनमें से सिर्फ़ एक ims प्रॉपर्टी ही मुख्य IM संपर्क हो सकती है.

फ़ील्ड

ims[].customProtocol

string

अगर प्रोटोकॉल की वैल्यू custom_protocol है, तो यह प्रॉपर्टी कस्टम प्रोटोकॉल की स्ट्रिंग को होल्ड करके रखती है.

ims[].customType

string

अगर IM type custom है, तो इस प्रॉपर्टी में कस्टम मान शामिल है और इसे सेट किया जाना चाहिए.

ims[].im

string

उपयोगकर्ता का IM नेटवर्क आईडी.

ims[].primary

boolean

अगर यह उपयोगकर्ता का मुख्य IM है. IM सूची में सिर्फ़ एक एंट्री का मान सही हो सकता है.

ims[].protocol

string

IM प्रोटोकॉल से IM नेटवर्क की पहचान होती है. वैल्यू, कस्टम नेटवर्क या स्टैंडर्ड नेटवर्क हो सकती है.

स्वीकार किए जाने वाले वैल्यू:
  • aim: AOL इंस्टैंट मैसेंजर प्रोटोकॉल
  • custom_protocol: कस्टम IM नेटवर्क प्रोटोकॉल
  • gtalk: Google टॉक प्रोटोकॉल
  • icq: ICQ प्रोटोकॉल
  • jabber: जैबर प्रोटोकॉल
  • msn: MSN मैसेंजर प्रोटोकॉल
  • net_meeting: नेट मीटिंग प्रोटोकॉल
  • qq: QQ प्रोटोकॉल
  • skype: Skype प्रोटोकॉल
  • yahoo: Yahoo मैसेंजर प्रोटोकॉल

ims[].type

string

IM खाते का प्रकार. अगर इस नीति को custom पर सेट किया जाता है, तो customType भी सेट होना चाहिए.

ये वैल्यू दी जा सकती हैं: custom, home, other, work.

customSchemas

value (Value format)

उपयोगकर्ता के कस्टम फ़ील्ड. कुंजी schemaName है और इसकी वैल्यू 'fieldName': 'field_value' हैं.

  • customSchemas.(key) एक नेस्ट किया गया ऑब्जेक्ट है.
  • customSchemas.(key).(key) की कोई भी वैल्यू हो सकती है.
isEnrolledIn2Sv

boolean

सिर्फ़ आउटपुट के लिए. उसे दो चरणों में पुष्टि की सुविधा में रजिस्टर किया गया हो (रीड-ओनली ऐक्सेस)

isEnforcedIn2Sv

boolean

सिर्फ़ आउटपुट के लिए. क्या दो चरणों में पुष्टि की सुविधा लागू की गई है (रीड-ओनली ऐक्सेस)

archived

boolean

यह बताता है कि उपयोगकर्ता को संग्रहित किया गया है या नहीं.

orgUnitPath

string

उपयोगकर्ता से जुड़े पैरंट संगठन का पूरा पाथ. अगर पैरंट संगठन टॉप-लेवल का है, तो उसे फ़ॉरवर्ड स्लैश (/) के तौर पर दिखाया जाता है.

recoveryEmail

string

उपयोगकर्ता का खाता वापस पाने के लिए ईमेल पता.

recoveryPhone

string

उपयोगकर्ता का खाता वापस पाने के लिए फ़ोन नंबर. फ़ोन नंबर, E.164 फ़ॉर्मैट में होना चाहिए. साथ ही, यह प्लस के निशान (+) से शुरू होना चाहिए. उदाहरण: +16506661212.

UserName

जेएसओएन के काेड में दिखाना
{
  "fullName": string,
  "familyName": string,
  "givenName": string,
  "displayName": string
}
फ़ील्ड
fullName

string

उपयोगकर्ता का पूरा नाम, नाम और उपनाम की वैल्यू को जोड़कर बनाया गया है.

familyName

string

उपयोगकर्ता का उपनाम. उपयोगकर्ता खाता बनाते समय ज़रूरी होता है.

givenName

string

उपयोगकर्ता का नाम उपयोगकर्ता खाता बनाते समय ज़रूरी होता है.

displayName

string

उपयोगकर्ता का डिसप्ले नेम. सीमा: 256 वर्ण.

तरीके

delete

उपयोगकर्ता को हटाता है.

get

उपयोगकर्ता को फिर से पाता है.

insert

उपयोगकर्ता बनाता है.

list

हटाए गए उपयोगकर्ताओं या किसी डोमेन के सभी उपयोगकर्ताओं की पेज नंबर वाली सूची लाता है.

makeAdmin

उपयोगकर्ता को सुपर एडमिन बनाता है.

patch

पैच सिमैंटिक का इस्तेमाल करके उपयोगकर्ता को अपडेट करता है.

signOut

उपयोगकर्ता को सभी वेब और डिवाइस सेशन से साइन आउट करता है और उनकी साइन-इन कुकी रीसेट करता है.

undelete

मिटाए गए उपयोगकर्ता को वापस लाएं.

update

उपयोगकर्ता को अपडेट करता है.

watch

उपयोगकर्ता सूची में हुए बदलावों पर नज़र रखता है.