الانتقال إلى المحتوى الرئيسي
DELETE
إنهاء الجلسة

إنهاء جلسة

DELETE /v1/agent-sessions/{sessionID} ينهي جلسة وكيل نشطة على الفور. يتم إبطال رمز الوصول ورمز التحديث الخاص بالجلسة، وتنتقل حالة الجلسة إلى "terminated". سيتم رفض أي مكالمات API لاحقة تستخدم رموز هذه الجلسة.
يتم تسجيل إنهاء الجلسة في سجل التدقيق بـ حدث AGENT_SESSION_TERMINATED. لا يتم إنشاء إيصال إنهاء تلقائيًا تم إنشاؤه — استخدم واجهة برمجة تطبيقات الإيصالات لإنشاء واحد إذا كان سير عمل الامتثال الخاص بك يتطلب ذلك.

المصادقة

يتطلب رأس X-API-Key أو رمز Bearer JWT. يتم اشتقاق مساحة العمل من بيانات الاعتماد الموثقة؛ لا ترسل X-Tenant-ID.

الاستجابة

string
الحالة المحدثة، دائمًا "terminated" عند النجاح.
string
معرف جلسة MAIP الذي تم إنهاؤه.

مثال


تنظيف الجلسات بالجملة

لإنهاء جميع الجلسات النشطة لوكيل معين (على سبيل المثال، أثناء الاستجابة للحوادث)، قم بسرد الجلسات المفلترة حسب الوكيل والحالة، ثم قم بإنهاء كل منها:
للاستجابة الأسرع للحوادث، تعليق الوكيل يحظر على الفور جميع عمليات الجلسة دون الحاجة إلى إنهاء الجلسة الفردية.

التفويضات

X-API-Key
string
header
مطلوب

مفتاح API للمصادقة من جهاز إلى جهاز

معلمات المسار

sessionId
string<uuid>
مطلوب

معرف الجلسة

الجسم

application/json
reason
string
مطلوب

سبب الإنهاء

الاستجابة

تم إنهاء الجلسة

session_id
string<uuid>
agent_id
string<uuid>
token
string

رمز حامل الجلسة (يُرجع مرة واحدة عند الإنشاء)

scopes
string[]
status
enum<string>
الخيارات المتاحة:
active,
terminated,
expired
metadata
object
expires_at
string<date-time>
created_at
string<date-time>
terminated_at
string<date-time>