> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# مفتاح الإيقاف

> إلغاء وكيل وذريته المفوضين، وإنهاء الجلسات، وتسجيل القرار الطارئ.

استخدم نقطة النهاية هذه لحالة طوارئ مثل وكيل مخترق. قم بتوفير معرف الوكيل وحادث غير فارغ `reason` (بحد أقصى 2000 بايت UTF-8). تحدد مساحة العمل والبيئة الموثقة الوكيل الذي يمكنك إلغاءه.

تقوم العملية بإلغاء الوكيل وذريته المفوضة، وإنهاء جلساتهم النشطة، وإلغاء روابط التفويض النشطة الخاصة بهم، والاحتفاظ بالقرار في معاملة قاعدة بيانات واحدة. إذا فشلت هذه المعاملة، يتم التراجع عن تغييرات حالتها.

> [!WARNING]
>
> الإلغاء دائم. سجل وكيلًا جديدًا إذا كان العمل بحاجة إلى الاستئناف. يتم الاحتفاظ بأدلة الإيصالات الصادرة مسبقًا؛ لا تقوم نقطة النهاية هذه بمسحها أو إعادة كتابتها.

### التحقق من النتيجة

يحتوي الرد الناجح على `status: "killed"`. يتضمن `agents_changed` الوكيل المطلوب؛ ويحسب `cascade_count` الفروع الملغاة حديثًا. يبلغ `sessions_terminated` و `delegations_revoked` عن الجلسات المتأثرة وروابط التفويض.

عند نجاح التوقيع المدار، يكون `receipt_status` هو `signed` ويحدد `receipt_id` إيصال إلغاء موقع. استرجعه عبر واجهة برمجة تطبيقات الإيصالات. صلاحية التوقيع وحالة دورة حياة الوكيل الملغى هي فحوصات منفصلة.

عندما يكون التوقيع غير متاح، يظل الإلغاء ناجحًا: يكون `receipt_status` هو `unavailable` و `receipt_id` هو `null`. يظل قرار الإلغاء الدائم مسجلاً. لا يترتب على هذه الاستجابة إيصال موقع أو إعادة محاولة توقيع تلقائية.

### سلوك التدقيق

تسجل الخدمة حدث `agent.killed` وحدث إبطال جنبًا إلى جنب مع تغييرات الحالة. لا تنشئ الاستجابة تثبيت شفافية خارجيًا، أو تسليم webhook، أو تسليم SIEM. تحقق من تلك القنوات بشكل منفصل إذا كانت عملية الحوادث الخاصة بك تعتمد عليها.

يعيد وكيل غير معروف في بيئة مساحة العمل المحددة `404`. يعيد وكيل تم إلغاؤه بالفعل `409`. راجع الحالة الحالية قبل إعادة محاولة طلب طارئ.


## OpenAPI

````yaml ar/mint-openapi.yaml POST /v1/agents/{agentId}/kill
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks هي بنية تحتية عالمية للتحقق من المستندات وبيانات الاعتماد والأصول
    الرقمية.يحدد هذا المواصفات واجهة برمجة التطبيقات (API) الأساسية للتفاعل مع
    خدمات Truthlocks.


    ## عناوين URL الأساسية

    - **الإنتاج**: `https://api.truthlocks.com`

    - **البيئة التجريبية (Sandbox)**: `https://sandbox-api.truthlocks.com`


    ## المصادقة

    - **مفاتيح API**: استخدم رأس `X-API-Key` للعمليات من جهاز إلى جهاز

    - **رموز Bearer**: استخدم `Authorization: Bearer <jwt>` للعمليات التي يبدأها
    المستخدم


    ## هوية المستأجر

    في بيئة الإنتاج، تُستمد هوية المستأجر من السياق المصادق عليه (مفتاح API أو
    JWT).

    يتم تجاهل رأس `X-Tenant-ID` في بيئة الإنتاج لمنع الانتحال.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: واجهة برمجة تطبيقات الإنتاج
  - url: https://sandbox-api.truthlocks.com
    description: بيئة اختبار (Sandbox)
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: إدارة مفاتيح ورموز API
  - name: Issuers
    description: تسجيل المصدر وإدارة الثقة
  - name: Keys
    description: إدارة المفاتيح التشفيرية لجهات الإصدار
  - name: Attestations
    description: دورة حياة الإشهاد (السك، الإلغاء، الاستبدال)
  - name: Verification
    description: حزم التحقق والإثبات للإشهاد
  - name: Governance
    description: سير عمل حوكمة المصدر (للمسؤول فقط)
  - name: Identity
    description: إدارة المنظمة والمستخدمين والأدوار
  - name: Audit
    description: استعلامات أحداث التدقيق
  - name: Tenant Console
    description: ملف تعريف المستأجر ونقاط نهاية دورة الحياة
  - name: Health
    description: نقاط نهاية صحة الخدمة وجاهزيتها
  - name: Risk
    description: استيعاب إشارة المخاطر واكتشاف الاحتيال
  - name: Risk Enforcement
    description: إجراءات إنفاذ المخاطر — الحظر والتحدي والحجر والتكوين
  - name: Billing
    description: إدارة الفوترة والاشتراكات والإضافات
  - name: Machine Identity
    description: >-
      بروتوكول هوية وكيل الآلة (MAIP) — تسجيل الوكيل، الجلسات، الثقة، الشهادة،
      الامتثال، التنسيق، والمراقبة
externalDocs:
  description: واجهة برمجة تطبيقات الشفافية للقراءة فقط (مواصفات خدمة منفصلة)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/agents/{agentId}/kill:
    post:
      tags:
        - Machine Identity
      summary: مفتاح إيقاف الطوارئ
      description: >-
        يلغي الوكيل المحدد وذريته المفوضة بشكل ذري، وينهي جلساتهم النشطة، ويسجل
        القرار. يتم الاحتفاظ بأدلة الإيصال الموجودة. لا تمنع انقطاعات التوقيع
        الإلغاء؛ افحص receipt_status قبل محاولة استرداد إيصال.
      operationId: maip.agents.kill
      parameters:
        - name: agentId
          in: path
          required: true
          schema:
            type: string
          description: معرف الوكيل
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                reason:
                  type: string
                  minLength: 1
                  maxLength: 2000
                  description: سبب الحادث غير فارغ، بحد أقصى 2000 بايت UTF-8
              type: object
              required:
                - reason
      responses:
        '200':
          description: تم قتل الوكيل
          content:
            application/json:
              schema:
                type: object
                properties:
                  agent_id:
                    type: string
                  tenant_id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - killed
                  agents_changed:
                    type: integer
                  cascade_count:
                    type: integer
                    description: تم إلغاء الوكلاء الفرعيين حديثًا، باستثناء الوكيل المطلوب.
                  sessions_terminated:
                    type: integer
                  delegations_revoked:
                    type: integer
                  reason:
                    type: string
                  killed_at:
                    type: string
                    format: date-time
                  receipt_id:
                    type: string
                    nullable: true
                    description: >-
                      معرف إيصال الإلغاء الموقع، أو لا شيء عندما يكون التوقيع
                      غير متاح.
                  receipt_status:
                    type: string
                    enum:
                      - signed
                      - unavailable
                    description: غير متاح لا يلغي الإلغاء الطارئ المكتمل.
        '400':
          description: خطأ في التحقق
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: المصادقة مطلوبة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: لم يتم العثور على الوكيل
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: الوكيل ملغى بالفعل أو حالة دورة حياته تمنع هذه العملية.
        '429':
          description: تجاوز حد المعدل
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: رمز خطأ قابل للقراءة آليًا
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: رسالة خطأ مقروءة بشريًا
        http_status:
          type: integer
          description: رمز حالة HTTP
        retry_after_ms:
          type: integer
          description: عدد المللي ثانية للانتظار قبل إعادة المحاولة (لحدود المعدل)
        details:
          type: object
          description: سياق خطأ إضافي
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: مفتاح API للمصادقة من جهاز إلى جهاز
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT للعمليات التي يبدأها المستخدم

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.