تخطَّ إلى المستندات
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"      }    ]  }

عملية إدراج أو تحديث، مثل منح العنوان: إعادة الإرسال بقيمة 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 أبدًا. وتبيّن صفحة المصادقة كيف تطلب رمزًا وتتحقق منه.

المرجع