تخطَّ إلى المستندات
API

تسجيل الدخول بعنوان واحد

تتيح كلمة مرور خاصة بالعنوان لشخص ما أن يسجّل الدخول إلى OpenEmail بعنوان واحد، فلا يقرأ إلا بريده ولا يرسل إلا منه.

GET/domains/{id}/addresses/{addressId}/login

ينفّذ أيًّا من الاستدعاءات الـ3 على مساحة عملك.

GET /domains/{id}/addresses/{addressId}/login

تتيح كلمة مرور خاصة بالعنوان لشخص ما أن يسجّل الدخول إلى OpenEmail بعنوان واحد، فلا يقرأ إلا بريده ولا يرسل إلا منه.

قراءة تسجيل الدخول

يتطلب members:write، مثل تعيين كلمة مرور. وlogin يساوي null حين لا تكون للعنوان كلمة مرور.

curl
curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
الاستجابة
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "login": {    "userId": "W2xR8tLq5nYc3vKp9mBd7fHs1aJe4gZu",    "name": "Invoices",    "createdAt": "2026-09-20T09:30:00.000Z",    "createdBy": "Ana Lima",    "passwordSetAt": "2026-09-28T14:05:00.000Z",    "passwordSetBy": "Ana Lima",    "lastSignedInAt": "2026-10-01T07:58:12.000Z"  }}

المفتاح المحصور بعناوين أو نطاقات معيّنة يُرفَض بـ 422 capability_unsupported، والتطبيق الذي يعمل نيابةً عن عضو لا يصل إلا إلى تسجيل الدخول لعنوان يصل إليه ذلك العضو.

تعيين كلمة المرور

يتطلب members:write. يمنح PUT /domains/{id}/addresses/{addressId}/login مع { password } العنوانَ كلمة مرور، أو يستبدل كلمة المرور التي لديه. ويبيّن created ما إذا كان تسجيل الدخول جديدًا.

curl
curl -X PUT "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{ "password": "'"$INBOX_PASSWORD"'" }'
الاستجابة
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "login": {    "userId": "W2xR8tLq5nYc3vKp9mBd7fHs1aJe4gZu",    "name": "Invoices",    "createdAt": "2026-09-20T09:30:00.000Z",    "createdBy": "Ana Lima",    "passwordSetAt": "2026-09-28T14:05:00.000Z",    "passwordSetBy": "Ana Lima",    "lastSignedInAt": "2026-10-01T07:58:12.000Z"  },  "created": false}

تحتاج كلمة المرور إلى 8 أحرف على الأقل تتضمن حرفًا صغيرًا وحرفًا كبيرًا ورقمًا ورمزًا خاصًا، وإلا فالاستدعاء يعطي 422 invalid_parameter على password. ولا يرسلها OpenEmail إلى أحد، فسلّمها بنفسك.

استبدال كلمة المرور يسجّل خروج كل من سجّل الدخول بالقديمة، ويزيل وجهات إعادة التوجيه التي أضافوها.

العنوان الذي يسجّل حساب OpenEmail الدخول به بالفعل يُرفَض بـ 409 account_exists، والعنوان المعطَّل بـ 409 address_unavailable. وتُرفَض أول كلمة مرور في مساحة عمل لا تشمل خطتها وصول الفريق بـ 403 plan_required.

يجب أن يملك المفتاح أو التطبيق كل صلاحية قد يستخدمها تسجيل الدخول لعنوان واحد، وإلا يُرفَض بـ 403 insufficient_authority.

يحتاج رمز وصول OAuth إلى رمز تحقق لهذا الاستدعاء. وإلى أن يتحقق التطبيق من رمز خلال آخر 60 دقيقة، يردّ الاستدعاء بـ 403 step_up_required ولا يغيّر شيئًا. ولا يُطلب ذلك من مفتاح API أبدًا. وتبيّن صفحة المصادقة كيف تطلب رمزًا وتتحقق منه.

إزالة تسجيل الدخول

يتطلب members:write. يزيل DELETE /domains/{id}/addresses/{addressId}/login كلمة المرور ويسجّل خروج كل من استخدمها. ويبقى العنوان وبريده.

curl
curl -X DELETE "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f/addresses/5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18/login" -H "$AUTH"
الاستجابة
{  "object": "address_login",  "addressId": "5f0c2b7e-8d41-4a6f-b913-7e2a0c4d9b18",  "address": "[email protected]",  "deleted": true}

العنوان الذي لا كلمة مرور له يعطي 404.

المرجع