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

# تقييم سياسة MAIP

> تقييم جميع سياسات الوكيل النشطة مقابل وكيل محدد ونطاق مطلوب

# تقييم سياسة MAIP

`POST /v1/maip/policies/evaluate`

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

> [!NOTE]
>
> يستخدم تقييم السياسة نموذج **الرفض يتجاوز**: إذا كانت أي سياسة نشطة ذات
> تطابق مشغلات قاعدة `deny`، يتم حظر الإجراء بغض النظر عن أي `allow`
> القواعد. علامة `requires_approval` إضافية -- يمكن تعيينها حتى عندما تكون
> الإجراء مسموح به.

### المصادقة

يتطلب رأس `X-API-Key` أو رمز Bearer JWT. نطاق المستأجر عبر ملف تعريف الارتباط أو مطالبة JWT.

### منطق التقييم

يقوم التقييم بثلاثة فحوصات متسلسلة:

1. **فحص حالة الوكيل** -- يجب أن يكون الوكيل `status: "active"`. يتم رفض الوكلاء المعلقين أو الملغاة دائمًا.
2. **فحص الوصول إلى النطاق** -- يجب أن يكون النطاق المطلوب موجودًا في النطاقات الممنوحة للوكيل. النطاقات المرفوضة صراحةً (المسبوقة بـ `!`) تمنع الوصول دائمًا.
3. **فحص قواعد السياسة** -- يتم تقييم جميع سياسات المستأجر النشطة بترتيب الأولوية. يتم ربط شروط كل قاعدة بـ AND. إذا تطابقت أي قاعدة `deny`، يتم حظر الإجراء.

### الاستجابة

**allowed** `boolean`

`true` إذا كان الإجراء مسموحًا به، `false` إذا تم رفضه بأي فحص.

**denied\_by** `string[]`

أسماء السياسات التي رفضت الإجراء. مصفوفة فارغة إذا سمح بذلك.

**reason** `string`

سبب الرفض المقروء بشريًا. أحد الأسباب التالية: - `"agent is not active"` -- الوكيل
معلق أو ملغى - `"scope not granted to agent"` -- النطاق ليس في
النطاقات الممنوحة للوكيل - `"denied by policy"` -- سياسة واحدة أو أكثر محظورة
العمل

**requires\_approval** `boolean`

`true` إذا كان أي قاعدة سياسة مطابقة تحتوي على `requires_approval: true`، حتى لو كان
الإجراء مسموح به بخلاف ذلك. يجب على المتصل تقديم موافقة بشرية
سير العمل قبل المتابعة.

### مثال

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/maip/policies/evaluate \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH",
    "scope": "data:write",
    "action": "update_customer_record",
    "resource": "customers/cust_12345"
  }'
```

```javascript theme={null}
const response = await fetch(
  "https://api.truthlocks.com/v1/maip/policies/evaluate",
  {
    method: "POST",
    headers: {
      "X-API-Key": "tl_live_...",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      agent_id: "maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH",
      scope: "data:write",
      action: "update_customer_record",
      resource: "customers/cust_12345",
    }),
  },
);
const result = await response.json();

if (!result.allowed) {
  console.error(`Denied by: ${result.denied_by.join(", ")}`);
} else if (result.requires_approval) {
  // Route to human approval workflow
}
```

```python theme={null}
import requests

response = requests.post(
    "https://api.truthlocks.com/v1/maip/policies/evaluate",
    headers={
        "X-API-Key": "tl_live_...",
        "Content-Type": "application/json",
    },
    json={
        "agent_id": "maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH",
        "scope": "data:write",
        "action": "update_customer_record",
        "resource": "customers/cust_12345",
    },
)
result = response.json()
```


## OpenAPI

````yaml ar/mint-openapi.yaml POST /v1/maip/policies/evaluate
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/maip/policies/evaluate:
    post:
      tags:
        - Machine Identity
      summary: تقييم سياسة MAIP
      description: |
        تقييم جميع سياسات MAIP النشطة مقابل وكيل محدد ونطاق مطلوب.
        يستخدم نموذج تجاوز الرفض: أي قاعدة رفض مطابقة تمنع الإجراء.
      operationId: maip.policies.evaluate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - agent_id
                - scope
              properties:
                agent_id:
                  type: string
                  description: معرف وكيل متوافق مع MAIP
                scope:
                  type: string
                  description: نطاق الإذن المطلوب
                action:
                  type: string
                  description: الإجراء المحدد الذي يتم تنفيذه
                resource:
                  type: string
                  description: المورد المحدد الذي يتم الوصول إليه
      responses:
        '200':
          description: نتيجة التقييم
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipPolicyEvaluateResponse'
        '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'
      security:
        - APIKey: []
components:
  schemas:
    MaipPolicyEvaluateResponse:
      type: object
      properties:
        allowed:
          type: boolean
          description: ما إذا كان الإجراء مسموحًا به
        denied_by:
          type: array
          items:
            type: string
          description: أسماء السياسات التي رفضت الإجراء
        reason:
          type: string
          description: سبب الرفض المقروء بشريًا
        requires_approval:
          type: boolean
          description: ما إذا كانت الموافقة البشرية مطلوبة
    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.