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

# سرد النطاقات

> سرد جميع نطاقات الأذونات المتاحة بما في ذلك المدمجة في النظام الأساسي والنطاقات المخصصة للمستأجر

# قائمة النطاقات

`GET /v1/scopes`

يعرض جميع نطاقات الأذونات المتاحة للمستأجر المصادق عليه. يتضمن ذلك النطاقات المضمنة المحددة بواسطة النظام الأساسي وأي نطاقات مخصصة أنشأها المستأجر. تتبع النطاقات تنسيق `resource:action` المحدد بواسطة بروتوكول MAIP.

### المصادقة

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

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

يعرض مصفوفة من كائنات تعريف النطاق.

**id** `string`

معرف UUID لتعريف النطاق.

**tenant\_id** `string`

معرف UUID للمستأجر الذي يمتلك هذا النطاق. `null` للمدمج على مستوى المنصة
النطاقات.

**scope** `string`

سلسلة النطاق الكاملة بتنسيق `resource:action` (على سبيل المثال، `"data:read"`،
`"model:train"`).

**resource** `string`

مكون المورد للنطاق (على سبيل المثال، `"data"`، `"model"`، `"tool"`).

**action** `string`

مكون الإجراء للنطاق (مثل، `"read"`، `"write"`، `"*"`).

**display\_name** `string`

اسم النطاق المقروء بشريًا.

**description** `string`

وصف تفصيلي لما يمنحه النطاق من وصول.

**category** `string`

فئة النطاق لأغراض تنظيمية.

**is\_builtin** `boolean`

`true` للنطاقات المعرفة بواسطة المنصة، `false` للنطاقات المخصصة التي أنشأها المستأجر.

**created\_at** `string`

طابع زمني لإنشاء ISO 8601.

### مثال

```bash theme={null}
curl -G https://api.truthlocks.com/v1/scopes \
  -H "X-API-Key: tl_live_..." \
  -d "category=data"
```

***

### فئات النطاق المضمنة

توفر المنصة أكثر من 25 نطاقًا مدمجًا عبر 6 فئات:

| الفئة | النطاقات | الوصف |
| - | - | - |
| `data` | `read`، `write`، `delete`، `*` | الوصول إلى موارد البيانات |
| `model` | `train`، `evaluate`، `deploy`، `attest`، `*` | دورة حياة نموذج التعلم الآلي |
| `tool` | `search.web`، `search.db`، `execute`، `*` | استدعاء الأداة |
| `agent` | `delegate`، `manage`، `inspect`، `*` | إدارة دورة حياة الوكيل |
| `admin` | `config`، `audit`، `billing`، `*` | العمليات الإدارية |
| `receipt` | `create`، `verify`، `revoke`، `*` | إدارة الإيصالات |

### مرجع تنسيق النطاق

```
resource:action         Standard scope (e.g., "data:read")
resource:*              Wildcard scope (e.g., "data:*" grants all data actions)
!resource:action        Negation scope (e.g., "!data:delete" explicitly denies)
resource:sub.action     Dotted sub-actions (e.g., "tool:search.web")
```


## OpenAPI

````yaml ar/mint-openapi.yaml GET /v1/scopes
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/scopes:
    get:
      tags:
        - Machine Identity
      summary: سرد النطاقات
      description: >-
        يعرض جميع نطاقات الأذونات المتاحة للمستأجر المصادق عليه، بما في ذلك
        الميزات المضمنة في النظام الأساسي والنطاقات المخصصة للمستأجر.
      operationId: maip.scopes.list
      parameters:
        - name: category
          in: query
          required: false
          schema:
            type: string
            enum:
              - data
              - model
              - tool
              - agent
              - admin
              - receipt
              - custom
          description: تصفية النطاقات حسب الفئة
      responses:
        '200':
          description: النطاقات المتاحة
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      format: uuid
                    tenant_id:
                      format: uuid
                      nullable: true
                      type: string
                    scope:
                      type: string
                    resource:
                      type: string
                    action:
                      type: string
                    display_name:
                      type: string
                    description:
                      type: string
                    category:
                      type: string
                    is_builtin:
                      type: boolean
                    created_at:
                      type: string
                      format: date-time
        '401':
          description: المصادقة مطلوبة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '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.