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

# Scopes auflisten

> Alle verfügbaren Berechtigungsumfänge auflisten, einschließlich plattforminterner und mandantenspezifischer Umfänge

# Scopes auflisten

`GET /v1/scopes`

Gibt alle Berechtigungsbereiche zurück, die dem authentifizierten Mandanten zur Verfügung stehen. Dies umfasst plattformdefinierte integrierte Bereiche und alle vom Mandanten erstellten benutzerdefinierten Bereiche. Bereiche folgen dem `resource:action`-Format, das durch das MAIP-Protokoll definiert ist.

### Authentifizierung

Erfordert `X-API-Key` Header oder Bearer JWT Token. Der Arbeitsbereich wird aus den authentifizierten Anmeldeinformationen abgeleitet; senden Sie `X-Tenant-ID` nicht.

### Antwort

Gibt ein Array von Bereichsdefinitionsobjekten zurück.

**id** `string`

UUID der Scope-Definition.

**tenant\_id** `string`

UUID des Mandanten, dem dieser Scope gehört. `null` für plattformweite integrierte
Scopes.

**scope** `string`

Die vollständige Scope-Zeichenfolge im Format `resource:action` (z.B. `"data:read"`,
`"model:train"`).

**resource** `string`

Die Ressourcenkomponente des Scopes (z.B. `"data"`, `"model"`, `"tool"`).

**action** `string`

Die Aktionskomponente des Scopes (z. B. `"read"`, `"write"`, `"*"`).

**display\_name** `string`

Menschenlesbarer Name für den Geltungsbereich.

**description** `string`

Detaillierte Beschreibung dessen, worauf der Bereich Zugriff gewährt.

**category** `string`

Bereichskategorie für organisatorische Zwecke.

**is\_builtin** `boolean`

`true` für plattformdefinierte Bereiche, `false` für vom Mandanten erstellte benutzerdefinierte Bereiche.

**created\_at** `string`

ISO 8601 Erstellungszeitstempel.

### Beispiel

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

***

### Eingebaute Bereichskategorien

Die Plattform bietet über 25 integrierte Scopes in 6 Kategorien:

| Kategorie | Bereiche | Beschreibung |
| - | - | - |
| `data` | `read`, `write`, `delete`, `*` | Datenressourcenzugriff |
| `model` | `train`, `evaluate`, `deploy`, `attest`, `*` | ML-Modell-Lebenszyklus |
| `tool` | `search.web`, `search.db`, `execute`, `*` | Werkzeugaufruf |
| `agent` | `delegate`, `manage`, `inspect`, `*` | Agent-Lebenszyklusmanagement |
| `admin` | `config`, `audit`, `billing`, `*` | Administrative Operationen |
| `receipt` | `create`, `verify`, `revoke`, `*` | Belegverwaltung |

### Referenz zum Bereichsformat

```
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 de/mint-openapi.yaml GET /v1/scopes
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks ist eine universelle Verifizierungsinfrastruktur für Dokumente,
    Anmeldeinformationen und digitale Assets.

    Diese Spezifikation definiert die kanonische API für die Interaktion mit
    Truthlocks-Diensten.


    ## Basis-URLs

    - **Produktion**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Authentifizierung

    - **API-Schlüssel**: Verwenden Sie den Header `X-API-Key` für
    Machine-to-Machine-Operationen

    - **Bearer Tokens**: Verwenden Sie `Authorization: Bearer <jwt>` für
    benutzerinitiierte Operationen


    ## Mandantenidentität

    In der Produktion wird die Mandantenidentität aus dem authentifizierten
    Kontext (API-Schlüssel oder JWT) abgeleitet.

    Der Header `X-Tenant-ID` wird in der Produktion ignoriert, um Spoofing zu
    verhindern.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: Produktions-API
  - url: https://sandbox-api.truthlocks.com
    description: Sandbox-Umgebung
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: API-Schlüssel- und Token-Verwaltung
  - name: Issuers
    description: Ausstellerregistrierung und Vertrauensmanagement
  - name: Keys
    description: Kryptographische Schlüsselverwaltung für Aussteller
  - name: Attestations
    description: Bestätigungslebenszyklus (prägen, widerrufen, ersetzen)
  - name: Verification
    description: Bestätigungsverifizierung und Proof-Bundles
  - name: Governance
    description: Aussteller-Governance-Workflows (nur Admin)
  - name: Identity
    description: Organisations-, Benutzer- und Rollenverwaltung
  - name: Audit
    description: Audit-Ereignisabfragen
  - name: Tenant Console
    description: Mandantenprofil- und Lebenszyklus-Endpunkte
  - name: Health
    description: Endpunkte für Dienststatus und Bereitschaft
  - name: Risk
    description: Erfassung von Risikosignalen und Betrugserkennung
  - name: Risk Enforcement
    description: >-
      Risikodurchsetzungsmaßnahmen – Blockieren, Herausfordern, Quarantäne und
      Konfiguration
  - name: Billing
    description: Verwaltung von Abrechnung, Abonnements und Add-ons
  - name: Machine Identity
    description: >-
      Machine Agent Identity Protocol (MAIP) – Agentenregistrierung, Sitzungen,
      Vertrauen, Zeugen, Compliance, Orchestrierung und Beobachtbarkeit
externalDocs:
  description: Transparenz-API nur lesend (separate Dienstspezifikation)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/scopes:
    get:
      tags:
        - Machine Identity
      summary: Scopes auflisten
      description: >-
        Gibt alle Berechtigungsbereiche zurück, die dem authentifizierten
        Mandanten zur Verfügung stehen, einschließlich plattforminterner und
        mandantenspezifischer Bereiche.
      operationId: maip.scopes.list
      parameters:
        - name: category
          in: query
          required: false
          schema:
            type: string
            enum:
              - data
              - model
              - tool
              - agent
              - admin
              - receipt
              - custom
          description: Bereiche nach Kategorie filtern
      responses:
        '200':
          description: Verfügbare Bereiche
          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: Authentifizierung erforderlich
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Ratenlimit überschritten
          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: Maschinenlesbarer Fehlercode
          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: Menschenlesbare Fehlermeldung
        http_status:
          type: integer
          description: HTTP-Statuscode
        retry_after_ms:
          type: integer
          description: >-
            Millisekunden, die vor einem erneuten Versuch gewartet werden sollen
            (für Ratenbegrenzungen)
        details:
          type: object
          description: Zusätzlicher Fehlerkontext
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API-Schlüssel für die Maschine-zu-Maschine-Authentifizierung
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT für benutzerinitiierte Operationen

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.