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

# تحديث وجهة SIEM

> إدارة وجهات تسليم التدقيق المحمية والمحددة النطاق بالبيئة.

> [!NOTE]
>
> تحقق من `delivery_available` في استجابة القائمة قبل تمكين وجهة. يغطي التسليم أحداث التدقيق الجديدة مع إسناد بيئة تم التحقق منها. لا يتم بث الأحداث التاريخية وغير المنسوبة. وجهة `enabled` ليست دليلًا على الاستيعاب الناجح؛ افحص `delivery_counts` وجهاز الاستقبال الخاص بك.

استخدم مفتاح واجهة برمجة التطبيقات لبيئة الاختبار أو الإنتاج المقصودة. يتطلب الإدراج `audit:read`؛ تتطلب التغييرات `audit:write`. يجب أن تنتمي جلسة المتصفح إلى مسؤول مساحة عمل. لا يمكن تحديث أو حذف وجهة من مستأجر أو بيئة أخرى.

يتم تشفير بيانات الاعتماد في وضع السكون ولا تظهر أبدًا في الردود. بالنسبة لخطافات الويب، قم بتوفير `secret`؛ بالنسبة لـ Splunk أو Datadog أو Elastic، قم بتوفير `token`. يتطلب تغيير نقطة نهاية توفير بيانات الاعتماد الخاصة بها مرة أخرى. لا يتم دعم تكوين CloudWatch.

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

راجع [دليل تسليم SIEM](https://docs.truthlocks.com/ar/guides/siem-integration.md) لإعادة المحاولات، وإعدادات المزود، والتحقق من الويب هوك. لاستيعاب اللقطات، استخدم [صادرات التدقيق](https://docs.truthlocks.com/ar/api-reference/audit/export.md) أو [صادرات أحداث المخاطر](https://docs.truthlocks.com/ar/api-reference/risk/exports/create.md). لا تمكن هذه الصادرات التدفق المستمر.


## OpenAPI

````yaml ar/mint-openapi.yaml PUT /v1/audit/siem/{id}
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/audit/siem/{id}:
    put:
      tags:
        - Audit
      summary: تحديث وجهة SIEM
      description: >-
        إدارة تكوين وجهة SIEM المحفوظة في بيئة مساحة العمل الموثقة. يمكن تسليم
        أحداث التدقيق الجديدة مع إسناد بيئة تم التحقق منها عندما تكون
        delivery_available صحيحة. لا يتم بث الأحداث التاريخية أو غير المنسوبة؛
        التمكين ليس دليلاً على الاستيعاب الناجح. يتم تشفير بيانات الاعتماد في
        وضع السكون ولا يتم إرجاعها أبدًا. تتطلب مفاتيح API صلاحية audit:read
        للإدراج أو audit:write للتغييرات؛ تتطلب جلسات المتصفح وصول مسؤول مساحة
        العمل.
      operationId: updateSiemDestination
      parameters:
        - name: id
          in: path
          required: true
          description: معرف وجهة SIEM.
          schema:
            type: string
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                endpoint:
                  type: string
                  format: uri
                  description: >-
                    اسم مضيف HTTPS عام على المنفذ 443، بدون بيانات اعتماد
                    المستخدم، أو معلمات الاستعلام، أو الجزء. يتطلب تغيير نقطة
                    النهاية توفير بيانات الاعتماد مرة أخرى. لا يحقق الحفظ ملكية
                    أو تسليمًا.
                  maxLength: 2048
                token:
                  type: string
                  description: >-
                    رمز لتهيئة Splunk أو Datadog أو Elastic. مطلوب عند الإنشاء
                    لهؤلاء المزودين. لا تقدم سرًا أيضًا.
                  writeOnly: true
                  minLength: 16
                  maxLength: 8192
                secret:
                  type: string
                  description: >-
                    سر مشترك لتكوين webhook. مطلوب عند الإنشاء لـ webhook. لا
                    توفر الرمز المميز أيضًا.
                  writeOnly: true
                  minLength: 16
                  maxLength: 8192
                enabled:
                  type: boolean
                  default: false
                  description: >-
                    تمكين تسليم أحداث التدقيق المنسوبة إلى البيئة المسجلة
                    حديثًا. يتطلب delivery_available=true؛ وإلا فإن true يُرجع
                    409. الافتراضي هو false عند إنشاء وجهة.
              additionalProperties: false
              example:
                enabled: false
      responses:
        '200':
          description: وجهة SIEM محدثة.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  environment_id:
                    type: string
                    format: uuid
                  provider:
                    type: string
                    enum:
                      - splunk
                      - datadog
                      - elastic
                      - webhook
                  endpoint:
                    type: string
                    format: uri
                  enabled:
                    type: boolean
                  status:
                    type: string
                    enum:
                      - configured_delivery_unavailable
                      - disabled
                      - enabled
                  credential_configured:
                    type: boolean
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
        '400':
          description: تكوين غير صالح، حقول غير مدعومة، نوع بيانات اعتماد أو معرف.
        '401':
          description: غير مصرح به
        '403':
          description: مطلوب نطاق تدقيق قابل للتطبيق أو وصول مسؤول مساحة العمل.
        '404':
          description: لم يتم العثور على الوجهة في بيئة مساحة العمل المصادق عليها.
        '409':
          description: التسليم غير متاح أو تم الوصول إلى حد البيئة المكون من 20 وجهة.
        '500':
          description: تعذر قراءة التكوين أو استمراره؛ لم يتم تأكيد أي نجاح.
      security:
        - APIKey: []
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.