الانتقال إلى المحتوى

البحث في الموقع

اكتب للبحث في الصفحات

Docs

واجهة البرمجة

واجهة برمجة الهويات

View as .md

أنشئ، واقرأ، وارعَ، وألغِ هويات الوكلاء في الدليل.

إنشاء هوية

POST /v1/identities مع اسم، وبريد إلكتروني للراعي، وسقف النطاق الذي يمكن للهوية طلبه. تُعيد الاستجابة معرّف الهوية، وحالتها، والراعي المُحدَّد.

الأسماء للبشر ولا تحتاج أن تكون فريدة؛ المعرّف هو المرجع الثابت والمعياري المستخدم في كل مكان آخر.

الاسترجاع والقوائم

GET /v1/identities/{id} تُعيد هوية واحدة مع راعيها، وسقف نطاقها، وحالتها. GET /v1/identities تسردها بترقيم صفحات بمؤشر وعوامل تصفية للراعي والحالة.

السرد للقراءة فقط وآمن للاستطلاع المتكرر؛ يعكس الإلغاءات وتغييرات الراعي فورًا.

تحديث الراعي

PATCH /v1/identities/{id} يغيّر الراعي أو يعدّل سقف النطاق. القيم السابقة تُحفظ في سجل التدقيق، بحيث يُظهر السجل دائمًا من كان مسؤولًا وما كان مسموحًا في أي وقت.

الإلغاء

POST /v1/identities/{id}/revoke يُبطل كل اعتماد ونطاق للهوية عبر جميع الأنظمة المتصلة، بشكل متزامن. يعود الاستدعاء بمجرد اكتمال الاحتواء ويُكتب الحدث في سجل التدقيق.