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

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

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_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

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

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

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

sshPublicKeys[].key

string

एसएसएच सार्वजनिक कुंजी.
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

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

value (Value format)

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

फ़ील्ड

ims[].customProtocol

string

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

ims[].customType

string

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

ims[].im

string

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

ims[].primary

boolean

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

ims[].protocol

string

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

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

ims[].type

string

इंस्टैंट मैसेजिंग खाते का टाइप. अगर 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

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