> ## 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.

# تغيير الاحتفاظ بالوثائق أو دورة حياتها

> يتطلب جلسة حامل عضو مساحة عمل مسجل الدخول. مفاتيح API غير مقبولة. تأتي مساحة العمل والبيئة من الجلسة المعتمدة. تتطلب التغييرات مالك مساحة العمل أو المسؤول.

استخدم جلسة حامل مساحة عمل صالحة. لا يمكن لمفتاح واجهة برمجة التطبيقات تخويل نقطة النهاية هذه. يتم اشتقاق مساحة العمل والبيئة الحالية من تلك الجلسة.

راجع [معالجة المعلومات](https://docs.truthlocks.com/ar/enterprise/information-handling.md) لقيود الملفات، وإدارة الإصدارات، والاحتجاز، والاحتفاظ، وسلوك التخلص.


## OpenAPI

````yaml ar/mint-openapi.yaml POST /v1/vault/documents/{id}/actions
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/vault/documents/{id}/actions:
    post:
      tags:
        - Document Vault
      summary: تغيير الاحتفاظ بالوثائق أو دورة حياتها
      description: >-
        يتطلب جلسة حامل عضو مساحة عمل مسجل الدخول. مفاتيح API غير مقبولة. تأتي
        مساحة العمل والبيئة من الجلسة المعتمدة. تتطلب التغييرات مالك مساحة العمل
        أو المسؤول.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: معرف المستند في بيئة مساحة العمل الحالية.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  enum:
                    - archive
                    - restore
                    - retention
                    - purge
                reason:
                  type: string
                  minLength: 10
                  maxLength: 2000
                confirmed:
                  type: boolean
                  enum:
                    - true
                  description: >-
                    تأكيد الإجراء المراجع. يزيل التطهير محتويات الملفات المؤهلة
                    بشكل دائم.
                legal_hold:
                  type: boolean
                  description: لإجراءات الاستبقاء. يمنع التعليق النشط التطهير.
                retain_until:
                  type: string
                  format: date-time
                  nullable: true
                  description: >-
                    لإجراءات الاستبقاء. قم بتضمين التاريخ الحالي عند تغيير
                    تعليق. لا يمكن تقصير أو مسح تاريخ موجود.
              required:
                - action
                - reason
                - confirmed
      responses:
        '200':
          description: استجابة ناجحة
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - confirmed
        '401':
          description: >-
            تعذر إكمال الطلب. اقرأ الخطأ المُرجع وحالة المستند الحالية قبل إعادة
            المحاولة.
        '403':
          description: >-
            تعذر إكمال الطلب. اقرأ الخطأ المُرجع وحالة المستند الحالية قبل إعادة
            المحاولة.
        '404':
          description: >-
            تعذر إكمال الطلب. اقرأ الخطأ المُرجع وحالة المستند الحالية قبل إعادة
            المحاولة.
        '409':
          description: >-
            تعذر إكمال الطلب. اقرأ الخطأ المُرجع وحالة المستند الحالية قبل إعادة
            المحاولة.
      security:
        - BearerAuth: []
components:
  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.