REST Resource: users

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

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

JSON के काेड में दिखाना 
{
  "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

सिर्फ़ आउटपुट के लिए. संसाधन का ETag.
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

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

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

संगठन में फ़ुल-टाइम, मिलीसेकंड में (100,000 = 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_fax, work_mobile, work_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

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

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)

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

फ़ील्ड

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

इस स्ट्रिंग में ऐसी स्ट्रिंग शामिल होती है जिसे कोई भी व्यक्ति आसानी से पढ़ सकता है. इसमें प्रोफ़ाइल के मालिक के बारे में सही तरीके से जानकारी दी जाती है. उदाहरण के लिए, "he/him/his" या "उन्हें/उन्हें/उनके".

gender.customGender

string

आपकी पसंद के मुताबिक लैंगिक जानकारी का नाम.

gender.type

string

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

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

thumbnailPhotoEtag

string

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

value (Value format)

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

फ़ील्ड

ims[].customProtocol

string

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

ims[].customType

string

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

ims[].im

string

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

ims[].primary

boolean

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

ims[].protocol

string

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

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

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

JSON के काेड में दिखाना 
{
  "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

 उपयोगकर्ताओं की सूची में बदलावों के लिए स्मार्टवॉच.