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

# Umfang erstellen

> Erstellen Sie einen benutzerdefinierten, mandantenbezogenen Berechtigungsumfang für eine fein granulare Zugriffssteuerung für Agenten.

# Scope erstellen

`POST /v1/scopes`

Erstellt einen benutzerdefinierten Berechtigungsumfang für den authentifizierten Mandanten. Benutzerdefinierte Umfänge erweitern das integrierte Umfangsregister um mandantenspezifische Berechtigungen. Die Umfangszeichenfolge wird automatisch aus den Feldern `resource` und `action` im Format `resource:action` zusammengesetzt.

Benutzerdefinierte Scopes werden anhand der MAIP-Scope-Formatregeln validiert: nur alphanumerische Zeichen, Punkte, Unterstriche, Bindestriche und Sternchen.

> [!NOTE]
>
> Benutzerdefinierte Bereiche sind mandantenisoliert. Sie erscheinen nicht in den Bereichslisten anderer Mandanten.
> Registrierungen. Eingebaute Plattform-Scopes können nicht überschrieben oder dupliziert werden.

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

**id** `string`

UUID der neu erstellten Scope-Definition.

**tenant\_id** `string`

UUID des besitzenden Mandanten.

**scope** `string`

Die zusammengesetzte Scope-Zeichenfolge im Format `resource:action`.

**resource** `string`

Die Ressourcenkomponente.

**action** `string`

Die Aktionskomponente.

**display\_name** `string`

Menschenlesbarer Bereichsname.

**description** `string`

Bereichsbeschreibung.

**category** `string`

Bereichskategorie.

**is\_builtin** `boolean`

Immer `false` für vom Mandanten erstellte Scopes.

**created\_at** `string`

ISO 8601 Erstellungszeitstempel.

### Beispiel

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/scopes \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "resource": "crm",
    "action": "contact.enrich",
    "display_name": "CRM Contact Enrichment",
    "description": "Allows agents to enrich CRM contact records via third-party providers",
    "category": "integration"
  }'
```

***

### Zuweisen benutzerdefinierter Bereiche zu Agenten

Nachdem Sie einen benutzerdefinierten Bereich erstellt haben, weisen Sie ihn Agenten während der [Registrierung](https://docs.truthlocks.com/de/api-reference/machine-identity/agents/register.md) oder über die [Delegation](https://docs.truthlocks.com/de/api-reference/machine-identity/agents/register.md) zu:

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/agents \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "agent_type": "pipeline",
    "display_name": "CRM Enrichment Pipeline",
    "scopes": ["crm:contact.enrich", "data:read"]
  }'
```


## OpenAPI

````yaml de/mint-openapi.yaml POST /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:
    post:
      tags:
        - Machine Identity
      summary: Umfang erstellen
      description: >-
        Erstellt einen benutzerdefinierten, mandantenbezogenen
        Berechtigungsumfang für die feingranulare Zugriffssteuerung von Agenten.
      operationId: maip.scopes.create
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                action:
                  type: string
                  description: >-
                    Aktionskomponente des Bereichs (z. B. „lesen“, „genehmigen“,
                    „*“)
                category:
                  type: string
                  description: Organisatorische Kategorie (Standard ist „custom“)
                description:
                  type: string
                  description: >-
                    Detaillierte Beschreibung dessen, was der Geltungsbereich
                    gewährt
                display_name:
                  type: string
                  description: Menschenlesbarer Name für den Bereich
                resource:
                  type: string
                  description: Ressourcenkomponente des Umfangs (z. B. „crm“, „payment“)
              type: object
              required:
                - resource
                - action
      responses:
        '201':
          description: Bereich erstellt
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                  tenant_id:
                    type: string
                    format: uuid
                  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
        '400':
          description: Validierungsfehler
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Authentifizierung erforderlich
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '409':
          description: Bereich existiert bereits
          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.