Admin SDK: Directory API

Admin SDK Directory API की मदद से, एंटरप्राइज़ डोमेन के एडमिन अपने संगठन के उपयोगकर्ताओं, ग्रुप, डिवाइसों, और उनसे जुड़े संसाधनों को देख और मैनेज कर सकते हैं. Cloud Identity API, कुछ संसाधनों को मैनेज करने के लिए अतिरिक्त तरीके उपलब्ध कराते हैं.

सेवा: admin.googleapis.com

इस सेवा को कॉल करने के लिए, हमारा सुझाव है कि आप Google की ओर से उपलब्ध कराई गई क्लाइंट लाइब्रेरी का इस्तेमाल करें. अगर आपके ऐप्लिकेशन को इस सेवा को कॉल करने के लिए, अपनी लाइब्रेरी का इस्तेमाल करना है, तो एपीआई अनुरोध करते समय यहां दी गई जानकारी का इस्तेमाल करें.

डिस्कवरी दस्तावेज़

जानकारी देने वाला दस्तावेज़, मशीन से पढ़े जा सकने वाले फ़ॉर्मैट में होता है. इसमें REST API के बारे में जानकारी दी जाती है और उन्हें इस्तेमाल करने का तरीका बताया जाता है. इसका इस्तेमाल क्लाइंट लाइब्रेरी, आईडीई प्लगिन, और Google API के साथ इंटरैक्ट करने वाले अन्य टूल बनाने के लिए किया जाता है. एक सेवा, एपीआई के बारे में ज़रूरी जानकारी देने वाले कई दस्तावेज़ उपलब्ध करा सकती है. यह सेवा इन एपीआई के बारे में ज़रूरी जानकारी देने वाला दस्तावेज़ उपलब्ध कराती है:

सेवा का एंडपॉइंट

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

  • https://admin.googleapis.com

REST रिसॉर्स: asps

तरीके
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
इस फ़ंक्शन का इस्तेमाल करके, उपयोगकर्ता की ओर से जारी किए गए एएसपी को मिटाया जा सकता है.
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
इस कुकी से, उपयोगकर्ता की ओर से जारी किए गए एएसपी के बारे में जानकारी मिलती है.
list GET /admin/directory/v1/users/{userKey}/asps
यह कुकी, किसी उपयोगकर्ता की ओर से जारी किए गए एएसपी की सूची दिखाती है.

REST रिसॉर्स: chromeosdevices

तरीके
action
(deprecated)		 POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
इसके बजाय, BatchChangeChromeOsDeviceStatus का इस्तेमाल करें.
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
इसकी मदद से, Chrome OS डिवाइस की प्रॉपर्टी वापस पाई जा सकती हैं.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
इस तरीके से, किसी खाते में मौजूद Chrome OS डिवाइसों की पेज के हिसाब से सूची मिलती है.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
इस फ़ंक्शन का इस्तेमाल करके, एक से ज़्यादा Chrome OS डिवाइसों को किसी संगठन की इकाई में ले जाया जा सकता है या जोड़ा जा सकता है.
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
इस फ़ंक्शन का इस्तेमाल करके, डिवाइस की अपडेट की जा सकने वाली प्रॉपर्टी अपडेट की जाती हैं. जैसे, annotatedUser, annotatedLocation, notes, orgUnitPath या annotatedAssetId.
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
इस फ़ंक्शन का इस्तेमाल करके, डिवाइस की अपडेट की जा सकने वाली प्रॉपर्टी अपडेट की जाती हैं. जैसे, annotatedUser, annotatedLocation, notes, orgUnitPath या annotatedAssetId.

REST रिसॉर्स: customer.devices.chromeos

तरीके
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
इससे ChromeOS डिवाइसों के किसी बैच का स्टेटस बदलता है.
countChromeOsDevices GET /admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices
यह अनुरोध से मेल खाने वाले ChromeOS डिवाइसों की संख्या दिखाता है.
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
डिवाइस को कोई निर्देश देता है, ताकि वह उसे पूरा कर सके.

REST रिसॉर्स: customer.devices.chromeos.commands

तरीके
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
डिवाइस को भेजे गए किसी निर्देश का डेटा मिलता है.

REST रिसॉर्स: customers

तरीके
get GET /admin/directory/v1/customers/{customerKey}
इससे ग्राहक की जानकारी मिलती है.
patch PATCH /admin/directory/v1/customers/{customerKey}
इस तरीके का इस्तेमाल करके, किसी ग्राहक की जानकारी में बदलाव किया जा सकता है.
update PUT /admin/directory/v1/customers/{customerKey}
इस तरीके का इस्तेमाल करके, ग्राहक की जानकारी अपडेट की जाती है.

REST रिसॉर्स: domainAliases

तरीके
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
इससे ग्राहक के डोमेन अन्य नाम को मिटाया जाता है.
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
इससे ग्राहक के डोमेन का उपनाम मिलता है.
insert POST /admin/directory/v1/customer/{customer}/domainaliases
इससे ग्राहक का डोमेन अन्य नाम डाला जाता है.
list GET /admin/directory/v1/customer/{customer}/domainaliases
इसमें ग्राहक के डोमेन के उपनामों की सूची होती है.

REST रिसॉर्स: domains

तरीके
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
इससे ग्राहक का डोमेन मिट जाता है.
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
इससे ग्राहक का डोमेन वापस पाया जा सकता है.
insert POST /admin/directory/v1/customer/{customer}/domains
इससे ग्राहक का डोमेन डाला जाता है.
list GET /admin/directory/v1/customer/{customer}/domains
इसमें ग्राहक के डोमेन की सूची होती है.

REST रिसॉर्स: groups

तरीके
delete DELETE /admin/directory/v1/groups/{groupKey}
किसी ग्रुप को मिटाता है.
get GET /admin/directory/v1/groups/{groupKey}
यह ग्रुप की प्रॉपर्टी वापस लाता है.
insert POST /admin/directory/v1/groups
इससे ग्रुप बनाया जाता है.
list GET /admin/directory/v1/groups
यह डोमेन के सभी ग्रुप या userKey दिए गए उपयोगकर्ता के सभी ग्रुप को वापस लाता है (पेज के हिसाब से बंटा हुआ).
patch PATCH /admin/directory/v1/groups/{groupKey}
इस तरीके का इस्तेमाल करके, किसी ग्रुप की प्रॉपर्टी अपडेट की जा सकती हैं.
update PUT /admin/directory/v1/groups/{groupKey}
इस तरीके का इस्तेमाल करके, किसी ग्रुप की प्रॉपर्टी अपडेट की जा सकती हैं.

REST रिसॉर्स: groups.aliases

तरीके
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
इस विकल्प से, किसी दूसरे ईमेल पते को हटाया जाता है.
insert POST /admin/directory/v1/groups/{groupKey}/aliases
ग्रुप के लिए कोई अन्य ईमेल पता जोड़ता है.
list GET /admin/directory/v1/groups/{groupKey}/aliases
किसी ग्रुप के सभी उपनामों की सूची बनाता है.

REST रिसॉर्स: members

तरीके
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
इस फ़ंक्शन का इस्तेमाल करके, किसी सदस्य को ग्रुप से हटाया जा सकता है.
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
इससे ग्रुप के किसी सदस्य की प्रॉपर्टी मिलती हैं.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
यह कुकी यह जांच करती है कि दिया गया उपयोगकर्ता, ग्रुप का सदस्य है या नहीं.
insert POST /admin/directory/v1/groups/{groupKey}/members
इस कमांड का इस्तेमाल करके, किसी उपयोगकर्ता को चुने गए ग्रुप में जोड़ा जाता है.
list GET /admin/directory/v1/groups/{groupKey}/members
यह ग्रुप में मौजूद सभी सदस्यों की पेज के हिसाब से सूची दिखाता है.
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
इस तरीके का इस्तेमाल करके, किसी ग्रुप में मौजूद उपयोगकर्ता की सदस्यता प्रॉपर्टी अपडेट की जाती हैं.
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
इससे किसी उपयोगकर्ता की सदस्यता को तय किए गए ग्रुप में अपडेट किया जाता है.

REST रिसॉर्स: mobiledevices

तरीके
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
ऐसी कार्रवाई करता है जिससे मोबाइल डिवाइस पर असर पड़ता है.
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
इससे मोबाइल डिवाइस हट जाता है.
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
यह किसी फ़ोन या टैबलेट की प्रॉपर्टी वापस लाता है.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
किसी खाते के लिए, उपयोगकर्ता के मालिकाना हक वाले सभी मोबाइल डिवाइसों की पेज के हिसाब से सूची वापस लाता है.

REST रिसॉर्स: orgunits

तरीके
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
संगठन की किसी इकाई को हटाता है.
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
संगठन की इकाई को वापस पाता है.
insert POST /admin/directory/v1/customer/{customerId}/orgunits
संगठन की इकाई जोड़ता है.
list GET /admin/directory/v1/customer/{customerId}/orgunits
यह किसी खाते के लिए, संगठन की सभी इकाइयों की सूची वापस लाता है.
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
संगठन की इकाई को अपडेट करता है.
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
संगठन की इकाई को अपडेट करता है.

REST रिसॉर्स: privileges

तरीके
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
इससे किसी ग्राहक के सभी विशेषाधिकारों की पेज के हिसाब से सूची मिलती है.

REST रिसॉर्स: resources.buildings

तरीके
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
इससे किसी बिल्डिंग को मिटाया जा सकता है.
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
किसी बिल्डिंग की जानकारी वापस पाता है.
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
बिल्डिंग शामिल करता है.
list GET /admin/directory/v1/customer/{customer}/resources/buildings
इस तरीके से, किसी खाते के लिए इमारतों की सूची मिलती है.
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
किसी बिल्डिंग में बदलाव करता है.
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
इस तरीके का इस्तेमाल करके, किसी बिल्डिंग की जानकारी अपडेट की जा सकती है.

REST रिसॉर्स: resources.calendars

तरीके
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
कैलेंडर के संसाधन को मिटाता है.
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
इस तरीके से, कैलेंडर संसाधन को वापस पाया जा सकता है.
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
इस तरीके का इस्तेमाल करके, कैलेंडर संसाधन डाला जाता है.
list GET /admin/directory/v1/customer/{customer}/resources/calendars
किसी खाते के लिए, कैलेंडर संसाधनों की सूची वापस लाता है.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
इस तरीके से, किसी कैलेंडर संसाधन में बदलाव किया जा सकता है.
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
इस तरीके का इस्तेमाल करके, कैलेंडर संसाधन को अपडेट किया जा सकता है.

REST रिसॉर्स: resources.features

तरीके
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
इस कमांड से कोई सुविधा मिटाई जाती है.
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
इस तरीके का इस्तेमाल करके, किसी सुविधा को वापस पाया जा सकता है.
insert POST /admin/directory/v1/customer/{customer}/resources/features
इससे कोई सुविधा जोड़ी जाती है.
list GET /admin/directory/v1/customer/{customer}/resources/features
इस फ़ंक्शन से, किसी खाते के लिए उपलब्ध सुविधाओं की सूची मिलती है.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
किसी सुविधा में बदलाव करता है.
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
इसकी मदद से, किसी सुविधा का नाम बदला जाता है.
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
किसी सुविधा को अपडेट करता है.

REST रिसॉर्स: roleAssignments

तरीके
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
भूमिका असाइनमेंट मिटाता है.
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
भूमिका असाइन करने की जानकारी वापस पाता है.
insert POST /admin/directory/v1/customer/{customer}/roleassignments
भूमिका असाइनमेंट बनाता है.
list GET /admin/directory/v1/customer/{customer}/roleassignments
इससे, पेज के हिसाब से सभी roleAssignments की सूची मिलती है.

REST रिसॉर्स: roles

तरीके
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
इस कमांड से किसी भूमिका को मिटाया जाता है.
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
किसी भूमिका को वापस लाता है.
insert POST /admin/directory/v1/customer/{customer}/roles
इससे कोई भूमिका बनाई जाती है.
list GET /admin/directory/v1/customer/{customer}/roles
यह किसी डोमेन में मौजूद सभी भूमिकाओं की पेज के हिसाब से सूची वापस लाता है.
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
किसी भूमिका में बदलाव करता है.
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
किसी भूमिका को अपडेट करता है.

REST रिसॉर्स: schemas

तरीके
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
यह स्कीमा मिटाता है.
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
यह स्कीमा वापस लाता है.
insert POST /admin/directory/v1/customer/{customerId}/schemas
यह स्कीमा बनाता है.
list GET /admin/directory/v1/customer/{customerId}/schemas
इससे किसी खरीदार के सभी स्कीमा वापस पाए जा सकते हैं.
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
किसी स्कीमा में बदलाव करता है.
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
यह स्कीमा को अपडेट करता है.

REST रिसॉर्स: tokens

तरीके
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
किसी ऐप्लिकेशन के लिए, उपयोगकर्ता के जारी किए गए सभी ऐक्सेस टोकन मिटा देता है.
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
इससे उपयोगकर्ता की ओर से जारी किए गए ऐक्सेस टोकन के बारे में जानकारी मिलती है.
list GET /admin/directory/v1/users/{userKey}/tokens
यह फ़ंक्शन, उपयोगकर्ता के तीसरे पक्ष के ऐप्लिकेशन को जारी किए गए टोकन का सेट दिखाता है.

REST रिसॉर्स: twoStepVerification

तरीके
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
इससे उपयोगकर्ता के लिए, दो चरणों में पुष्टि करने की सुविधा बंद हो जाती है.

REST रिसॉर्स: users

तरीके
delete DELETE /admin/directory/v1/users/{userKey}
इससे किसी उपयोगकर्ता को मिटाया जाता है.
get GET /admin/directory/v1/users/{userKey}
इस फ़ंक्शन का इस्तेमाल करके, किसी उपयोगकर्ता की जानकारी मिलती है.
insert POST /admin/directory/v1/users
इससे उपयोगकर्ता बनाया जाता है.
list GET /admin/directory/v1/users
यह फ़ंक्शन, मिटाए गए उपयोगकर्ताओं या किसी डोमेन के सभी उपयोगकर्ताओं की पेज के हिसाब से सूची वापस लाता है.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
इससे किसी उपयोगकर्ता को सुपर एडमिन बनाया जाता है.
patch PATCH /admin/directory/v1/users/{userKey}
पैच से जुड़े सेमेंटिक का इस्तेमाल करके, किसी उपयोगकर्ता की जानकारी अपडेट करता है.
signOut POST /admin/directory/v1/users/{userKey}/signOut
यह कुकी, उपयोगकर्ता को वेब और डिवाइस के सभी सेशन से साइन आउट करती है. साथ ही, साइन-इन करने से जुड़ी कुकी को रीसेट करती है.
undelete POST /admin/directory/v1/users/{userKey}/undelete
इस तरीके का इस्तेमाल करके, मिटाए गए उपयोगकर्ता को वापस लाया जा सकता है.
update PUT /admin/directory/v1/users/{userKey}
इस तरीके का इस्तेमाल करके, किसी उपयोगकर्ता की जानकारी अपडेट की जा सकती है.
watch POST /admin/directory/v1/users/watch
उपयोगकर्ताओं की सूची में होने वाले बदलावों पर नज़र रखता है.

REST रिसॉर्स: users.aliases

तरीके
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
इस विकल्प से, किसी दूसरे ईमेल पते को हटाया जाता है.
insert POST /admin/directory/v1/users/{userKey}/aliases
इससे कोई उपनाम जोड़ा जाता है.
list GET /admin/directory/v1/users/{userKey}/aliases
किसी उपयोगकर्ता के सभी ईमेल पतों की सूची बनाता है.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
उपयोगकर्ताओं की सूची में होने वाले बदलावों पर नज़र रखता है.

REST रिसॉर्स: users.photos

तरीके
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
इससे उपयोगकर्ता की फ़ोटो हट जाती है.
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
यह कुकी, उपयोगकर्ता की फ़ोटो को वापस लाती है.
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
उपयोगकर्ता के लिए फ़ोटो जोड़ता है.
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
उपयोगकर्ता के लिए फ़ोटो जोड़ता है.

REST रिसॉर्स: verificationCodes

तरीके
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
यह कुकी, उपयोगकर्ता के लिए पुष्टि करने वाले नए बैकअप कोड जनरेट करती है.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
इससे उपयोगकर्ता के मौजूदा बैकअप पुष्टि करने वाले कोड अमान्य हो जाते हैं.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
यह फ़ंक्शन, बताए गए उपयोगकर्ता के लिए, पुष्टि करने वाले मान्य बैकअप कोड का मौजूदा सेट दिखाता है.