الانتقال إلى المحتوى الرئيسي
POST
curl
يحذف عدة قوالب بيومترية دفعة واحدة في استدعاء واحد. وفّر إما قائمة معرّفات صريحة، أو delete_all: true، ويمكنك اختيارياً تضييق النتائج بالمرشحات نفسها المستخدمة في عرض القوالب البيومترية.

نص الطلب

delete_all: true بدون مرشحات يحذف نهائياً كل قالب بيومتري في التطبيق، ولا يمكن التراجع عن ذلك. شغّل عدّ القوالب البيومترية بالمرشحات نفسها أولاً للتأكد مما سيُحذف.

أمثلة

تُحذف القوالب واحداً تلو الآخر، وتُبلَّغ نتيجة كل قالب بالحالة purged أو already_purged. إذا كان أحد المخازن البيومترية غير متاح، يعيد الاستدعاء الرمز 503 عند أول قالب يفشل. تبقى القوالب التي حُذفت نهائياً في وقت سابق من الطلب نفسه محذوفة، وينتقل القالب الذي فشل إلى purge_failed (وهو مستبعد من المطابقة بالفعل). إعادة الطلب تُكمل المهمة.

الأخطاء

التفويضات

x-api-key
string
header
مطلوب

مفتاح API الخاص بتطبيقك، من Developers -> API keys في Business Console. يمتلك المفتاح الأساسي وصولاً كاملاً. يمكن تحديد نطاق المفتاح المسمى: لا شيء، أو قراءة، أو كتابة لكل مورد، ومحدوداً ببعض مسارات العمل أو بالجلسات المقبولة، وبقائمة من عناوين IP، وبتاريخ انتهاء الصلاحية. يشير 401 إلى أن المفتاح غير صحيح أو ملغى أو منتهي الصلاحية؛ ويشير 403 إلى أنه لم يتم إرسال أي مفتاح، أو أن المفتاح ليس لديه حق الوصول إلى هذا المورد أو الإجراء، أو أن الطلب جاء من عنوان خارج قائمة عناوين IP الخاصة به؛ ويشير 404 في مسار جلسة إلى أن الجلسة خارج مسارات العمل أو الحالات الخاصة بالمفتاح. يتلقى المفتاح الذي لا يمتلك حق الوصول إلى الوسائط عناوين URL للصور ومقاطع الفيديو وملفات PDF كـ null، ويتلقى المفتاح الذي لا يمتلك إذن كتابة للجلسات روابط الجلسة وtoken كـ null. راجع https://docs.didit.me/console/api-keys.

الجسم

application/json
template_uuids
string<uuid>[]

القوالب المراد حذفها نهائيًا. مطلوب ما لم تكن قيمة delete_all هي true. يتم الإبلاغ عن المعرّفات التي حُذفت نهائيًا بالفعل كـ already_purged.

Minimum array length: 1
delete_all
boolean
افتراضي:false

عندما تكون true، يتم مسح كل قالب يطابق عوامل التصفية أدناه (جميع قوالب التطبيق في حال عدم تحديد أي عامل تصفية). يتم تجاهل template_uuids. لا يمكن التراجع عن هذا الإجراء.

vendor_data
string

فقط مع delete_all: مطابقة لسلسلة نصية فرعية غير حساسة لحالة الأحرف في vendor_data للمستخدم المالك.

vendor_user_uuid
string<uuid>

فقط مع delete_all: مطابقة تامة للمستخدم المالك.

status
enum<string>

فقط مع delete_all.

الخيارات المتاحة:
pending,
active,
expired,
held_out_of_use,
purge_pending,
purge_failed
source_type
enum<string>

فقط مع delete_all.

الخيارات المتاحة:
session_delete,
automatic_retention,
backfill
retained_from
string<date-time>

فقط مع delete_all.

retained_to
string<date-time>

فقط مع delete_all. يجب ألا يكون أقدم من retained_from.

الاستجابة

نتائج التطهير لكل قالب.

results
object[]
آخر تعديل في ٧ نوفمبر ٢٠٢٦