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,
  "isGuestUser": boolean,
  "guestAccountInfo": {
    object (GuestAccountInfo)
  }
}
फ़ील्ड
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 crypt library के मुताबिक हो. यह DES, MD5 (हैश प्रीफ़िक्स $1$), SHA-256 (हैश प्रीफ़िक्स $5$), और SHA-512 (हैश प्रीफ़िक्स $6$) हैश एल्गोरिदम के साथ काम करता है.

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

boolean

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

किसी भाषा का आईएसओ 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

यह SSH सार्वजनिक पासकोड का 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

सिर्फ़ आउटपुट के लिए. उपयोगकर्ता की फ़ोटो का ईटैग (रीड-ओनली)
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.
isGuestUser

boolean

इम्यूटेबल. इस कुकी से पता चलता है कि उपयोगकर्ता मेहमान है या नहीं.
guestAccountInfo

object (GuestAccountInfo)

इम्यूटेबल. मेहमान से जुड़े मेटाडेटा के अन्य फ़ील्ड

UserName

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

string

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

string

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

string

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

string

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

GuestAccountInfo

मेहमान उपयोगकर्ताओं के लिए खाते की जानकारी.

JSON के काेड में दिखाना 
{
  "primaryGuestEmail": string
}
फ़ील्ड
primaryGuestEmail

string

इम्यूटेबल. मेहमान का बाहरी ईमेल पता.

तरीके

createGuest

 मेहमान उपयोगकर्ता के तौर पर एक ऐसा खाता बनाएं जिसके पास Workspace की कुछ सुविधाओं का ऐक्सेस हो.

delete

 यह कुकी, किसी उपयोगकर्ता को मिटाती है.

get

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

insert

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

list

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

makeAdmin

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

patch

 यह फ़ंक्शन, पैच से जुड़े सेमेंटिक का इस्तेमाल करके किसी उपयोगकर्ता की जानकारी अपडेट करता है.

signOut

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

undelete

 यह कुकी, मिटाए गए उपयोगकर्ता की प्रोफ़ाइल को वापस लाती है.

update

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

watch

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