दस्तावेज़ पर जाएँ
API

डोमेन ग्रांट और निरस्त करें

एक साथ पूरा डोमेन: उस पर मौजूद हर पता, बाद में जोड़े गए पतों समेत।

POST/members/{userId}/domains

2 कॉल में से कोई भी आपके वर्कस्पेस पर चलाता है।

POST /members/{userId}/domains

एक साथ पूरा डोमेन: उस पर मौजूद हर पता, बाद में जोड़े गए पतों समेत।

डोमेन ग्रांट करें

members:write चाहिए। POST /members/{userId}/domains के साथ { domainId, access }; access का डिफ़ॉल्ट member है। पूरा सदस्य उसकी मौजूदा स्थिति में लौटाता है, ग्रांट domains में होता है।

curl
curl -X POST "$OE/members/nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t/domains" -H "$AUTH" \    -H "Content-Type: application/json" \    -d '{ "domainId": "7d2a9c41-5b3e-4f8a-9c06-1e2b3c4d5e6f", "access": "viewer" }'
प्रतिक्रिया
{    "object": "member",    "userId": "nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t",    "email": "[email protected]",    "role": { "id": "role_2b81de079c1f0a4b7e05d386", "name": "Support", "builtin": null },    "addresses": [],    "domains": [      {        "domainId": "7d2a9c41-5b3e-4f8a-9c06-1e2b3c4d5e6f",        "domain": "acme.com",        "access": "viewer"      }    ]  }

पते के ग्रांट की तरह एक upsert: अलग access के साथ दोबारा पोस्ट करने पर दूसरा ग्रांट जुड़ने के बजाय मौजूदा ग्रांट बदल जाता है।

डोमेन ग्रांट उस डोमेन के हर पते तक पहुँचता है, ग्रांट के बाद जोड़े गए पतों समेत, इसलिए यह उस व्यक्ति के लिए ग्रांट है जो पूरा डोमेन सँभालता है। एक-एक करके ग्रांट किए गए पते इसके साथ वैसे ही बने रहते हैं।

व्यक्ति का पहले से वर्कस्पेस में होना ज़रूरी है, इसलिए पहले उन्हें POST /members से आमंत्रित करें। मालिक को member_is_owner के साथ मना किया जाता है, क्योंकि वे हर डोमेन तक पहुँचते हैं, और जिस वर्कस्पेस के प्लान में टीम एक्सेस नहीं है उसे 403 plan_required के साथ मना किया जाता है।

कुछ ख़ास पतों या डोमेनों तक सीमित कुंजी या ऐप को 422 capability_unsupported के साथ मना किया जाता है, और किसी सदस्य की ओर से काम करने वाला ऐप केवल वही डोमेन दे सकता है जिस तक वह सदस्य पहुँचता है।

OAuth एक्सेस टोकन को इस कॉल के लिए सत्यापन कोड चाहिए। जब तक ऐप पिछले 60 मिनट में कोई कोड सत्यापित न कर ले, कॉल 403 step_up_required लौटाती है और कुछ नहीं बदलती। API कुंजी से कभी नहीं पूछा जाता। प्रमाणीकरण पेज बताता है कि कोड कैसे माँगें और सत्यापित करें।

डोमेन निरस्त करें

members:write चाहिए। DELETE /members/{userId}/domains/{domainId}। उस डोमेन को हटाकर सदस्य लौटाता है।

curl
curl -X DELETE \    "$OE/members/nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t/domains/7d2a9c41-5b3e-4f8a-9c06-1e2b3c4d5e6f" \    -H "$AUTH"
प्रतिक्रिया
{    "object": "member",    "userId": "nQ8vBz1aRd4tYwKx7fQ2mN8vBz1aRd4t",    "email": "[email protected]",    "role": { "id": "role_2b81de079c1f0a4b7e05d386", "name": "Support", "builtin": null },    "addresses": [],    "domains": []  }

डोमेन के जो पते एक-एक करके ग्रांट किए गए थे वे ग्रांट बने रहते हैं, और व्यक्ति की भूमिका बनी रहती है।

जो डोमेन इस वर्कस्पेस का नहीं है उसे चुपचाप अनदेखा करने के बजाय 422 member_not_found के साथ मना किया जाता है।

OAuth एक्सेस टोकन को इस कॉल के लिए सत्यापन कोड चाहिए। जब तक ऐप पिछले 60 मिनट में कोई कोड सत्यापित न कर ले, कॉल 403 step_up_required लौटाती है और कुछ नहीं बदलती। API कुंजी से कभी नहीं पूछा जाता। प्रमाणीकरण पेज बताता है कि कोड कैसे माँगें और सत्यापित करें।

संदर्भ