پرش به مستندات
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 هرگز خواسته نمی‌شود. صفحهٔ احراز هویت نشان می‌دهد چطور کد بخواهید و آن را تأیید کنید.

مرجع