> ## 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 للمستهلك

> يُرجع جميع مفاتيح API للمستهلك المصادق عليه. لا تُرجع الأسرار أبدًا في استجابات القائمة. يتطلب جلسة مستهلك فردية مصادق عليها؛ لا يمكن لجلسة عمل أو مفتاح API لمساحة العمل أن يحل محل هوية المستخدم.

يُرجع جميع مفاتيح API التي تنتمي إلى المستهلك المصادق عليه. لا تُدرج الأسرار أبدًا في استجابات القائمة - يُعرض فقط بادئة المفتاح.

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


## OpenAPI

````yaml ar/mint-openapi.yaml GET /v1/consumer/api-keys
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/consumer/api-keys:
    get:
      tags:
        - Consumer
      summary: سرد مفاتيح API للمستهلك
      description: >-
        يُرجع جميع مفاتيح API للمستهلك المصادق عليه. لا تُرجع الأسرار أبدًا في
        استجابات القائمة. يتطلب جلسة مستهلك فردية مصادق عليها؛ لا يمكن لجلسة عمل
        أو مفتاح API لمساحة العمل أن يحل محل هوية المستخدم.
      responses:
        '200':
          description: قائمة مفاتيح API للمستهلك
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConsumerAPIKey'
              example:
                - key_id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
                  name: My integration key
                  prefix: tlk_abcd1234
                  status: active
                  scopes:
                    - consumer:read
                    - consumer:write
                    - attestations:mint
                    - attestations:read
                    - verify:read
                  created_at: '2026-03-01T12:00:00.000Z'
                  expires_at: '2026-05-30T12:00:00.000Z'
                  last_used_at: '2026-03-20T09:15:00.000Z'
        '401':
          description: المصادقة مطلوبة
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              example:
                code: AUTH_REQUIRED
                message: Authentication required
                http_status: 401
      security:
        - BearerAuth: []
components:
  schemas:
    ConsumerAPIKey:
      type: object
      properties:
        key_id:
          type: string
          format: uuid
        name:
          type: string
          description: تسمية مقروءة بشريًا للمفتاح
        prefix:
          type: string
          description: أول 12 حرفًا من المفتاح، لأغراض العرض
        status:
          type: string
          enum:
            - active
            - revoked
        scopes:
          type: array
          items:
            type: string
          description: نطاقات الأذونات الممنوحة لهذا المفتاح
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
          description: تنتهي صلاحية المفاتيح بعد 90 يومًا من الإنشاء
        last_used_at:
          type: string
          format: date-time
          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.