Zum Hauptinhalt springen
Truthlocks unterstützt mehrere Authentifizierungsmethoden, um den API-Zugriff zu sichern. Dieser Leitfaden behandelt API-Schlüssel, JWT-Tokens und Best Practices für die Sicherheit.

Authentifizierungsmethoden

API-Schlüssel

Langlebige Anmeldeinformationen für die Server-zu-Server-Kommunikation. Empfohlen für Backend-Dienste.

Bearer Tokens (JWT)

Kurzlebige Tokens für authentifizierte Benutzer. Ideal für Frontend-Anwendungen und Benutzerkontext.

API-Schlüssel

Truthlocks hat zwei Arten von API-Schlüsseln, je nachdem, wie Sie die Plattform nutzen:

Schlüssel übergeben

Fügen Sie Ihren API-Schlüssel mit einem dieser Header hinzu:
Sie können auch den Authorization Header mit dem ApiKey Schema verwenden:
Diese Formate authentifizieren API-Schlüssel-aktivierte Endpunkte. Einige Operationen erfordern ein Benutzer-Bearer-Token und Rollenprüfungen; öffentliche Gesundheitsendpunkte benötigen beides nicht. X-API-Key ist in den Beispielen in dieser Dokumentation häufiger anzutreffen.

Mandanten-API-Schlüssel

Mandantenschlüssel sind die primäre Authentifizierungsmethode für Organisationen, die Truthlocks verwenden. Sie sind auf einen Mandanten beschränkt und unterstützen fein abgestufte Berechtigungen.

Schlüsselstruktur

Bereiche

Mandanten-API-Schlüssel können auf bestimmte Berechtigungen beschränkt werden:
Prinzip der geringsten Privilegien: Gewähren Sie nur die Bereiche, die Ihre Anwendung benötigt. tatsächlich benötigt. Ein Schlüssel mit nur attestations:mint sollte nicht auch users:write.

Erstellen eines Mandantenschlüssels

Über Konsole

  1. Navigieren Sie zu console.truthlocks.com/api-keys
  2. Klicken Sie auf „API-Schlüssel erstellen“
  3. Geben Sie einen aussagekräftigen Namen ein (z. B. „Produktions-Backend“)
  4. Wählen Sie die Umgebung (Produktion oder Sandbox) und die erforderlichen Bereiche aus
  5. Kopieren Sie den Schlüssel sofort – er wird nicht wieder angezeigt

Über API

Request
Response
Kritisch: Das Feld secret wird nur einmal zum Zeitpunkt der Erstellung zurückgegeben. Speichern Sie es es sofort in einem Secrets Manager.

Consumer-API-Schlüssel

Verbraucherschlüssel ermöglichen einzelnen Benutzern den programmatischen Zugriff auf die Protect- und Verify-APIs – zum Beispiel, um Bestätigungen aus einer CI-Pipeline zu prägen oder den Inhaltsschutz in Ihre eigenen Tools zu integrieren.

Wichtige Details

  • Jedes Konto unterstützt bis zu 5 aktive Schlüssel.
  • Schlüssel verfallen automatisch nach 90 Tagen.
  • Widerrufene oder abgelaufene Schlüssel können nicht reaktiviert werden – erstellen Sie stattdessen einen neuen.

Feste Bereiche

Verbraucherschlüssel werden mit einem festen Satz von Scopes ausgegeben, die nicht angepasst werden können:

Erstellen eines Verbraucherschlüssels

1

Einstellungen öffnen

Gehen Sie in der Verify-Portal-Seitenleiste zu Einstellungen > API-Schlüssel.
2

Einen Schlüssel erstellen

Klicken Sie auf API-Schlüssel erstellen, geben Sie einen aussagekräftigen Namen ein und bestätigen Sie. Der vollständige Geheimnis wird einmal angezeigt – kopieren und sicher speichern.
3

Schlüssel verwenden

Übergeben Sie den Schlüssel im X-API-Key Header bei jeder Anfrage:
Ausführliche Informationen zur Verwaltung von Verbraucherschlüsseln finden Sie im Verbraucherportal-Leitfaden.

Bearer-Tokens (JWT)

JWT-Token werden verwendet, wenn Sie API-Aufrufe im Namen eines authentifizierten Benutzers tätigen müssen, z. B. von einer Web- oder Mobilanwendung aus.

Verwendung von Bearer-Tokens

Token-Struktur

Token-Lebensdauer

Authenticator-MFA für Console-Konten

Öffnen Sie in der Console Einstellungen → Sicherheit → Authentifikator MFA, um Google Authenticator oder eine andere zeitbasierte Authentifikator-App zu verbinden.
  1. Bestätigen Sie Ihr aktuelles lokales Truthlocks-Passwort.
  2. Scannen Sie den privaten QR-Code oder geben Sie den Einrichtungsschlüssel in Ihrem Authentifikator als zeitbasiertes Konto ein.
  3. Geben Sie den sechsstelligen Code aus der App ein, um MFA zu aktivieren.
  4. Speichern Sie die zehn Wiederherstellungscodes, die nach der Bestätigung angezeigt werden. Sie werden einmal angezeigt, und jeder Code funktioniert einmal.
Neue Anmeldungen erfordern den zweiten Faktor entweder nach Ihrem Passwort oder Ihrem Geschäftsidentitätsanbieter. Der Verifizierungsschritt läuft nach fünf Minuten ab. Wiederholte falsche Codes sperren die Verifizierung für das Konto vorübergehend. Ein bereits akzeptierter Code kann nicht wiederverwendet werden. Um Wiederherstellungscodes zu ersetzen oder MFA zu deaktivieren, bestätigen Sie Ihr Passwort und einen neuen Authentifizierungscode oder einen unbenutzten Wiederherstellungscode. Das Ersetzen von Wiederherstellungscodes macht den vorherigen Satz ungültig. SSO-Benutzer, die noch nie ein lokales Truthlocks-Passwort festgelegt haben, können den Passwort-Reset-Flow für ihre registrierte E-Mail vor der Registrierung verwenden. Die MFA-Registrierung gilt für Ihr eigenes Konto. Sie registriert keine anderen Mitglieder und erzwingt keine Workspace-weite MFA-Anforderung. Das Aktivieren von MFA widerruft nicht automatisch bestehende Sitzungen. API-Schlüssel bleiben separate Systemanmeldeinformationen.

Best Practices für die Sicherheit

✅ Geheimnisverwaltung verwenden

Speichern Sie API-Schlüssel in Google Secret Manager, HashiCorp Vault oder Ähnlichem. Niemals Schlüssel im Anwendungscode fest codieren.

✅ Schlüssel regelmäßig rotieren

Erstellen Sie regelmäßig neue Schlüssel und widerrufen Sie alte. Verwenden Sie aussagekräftige Namen mit Daten (z. B. „Backend-2026-Q1“).

✅ Scopes einschränken

Gewähren Sie nur die tatsächlich benötigten Berechtigungen. Überprüfen und auditieren Sie die Schlüsselbereiche regelmäßig.

❌ Niemals im Frontend offenlegen

API-Schlüssel sollten niemals in clientseitigem JavaScript enthalten sein. Verwenden Sie JWT-Token für die Frontend-Authentifizierung.

❌ Niemals in Git committen

Verwenden Sie Umgebungsvariablen oder Geheimnisverwaltung. Fügen Sie .env* hinzu .gitignore.

Nächste Schritte

Verbraucherportal

Verwalten Sie Consumer-API-Schlüssel, Schutzmaßnahmen und Einstellungen.

Umgebungen

Sandbox vs. Produktionskonfiguration und Basis-URLs.

RBAC & Berechtigungen

Verstehen Sie Rollen, Berechtigungen und Zugriffssteuerung.

Audit-Protokolle

Verfolgen Sie alle API-Aktivitäten und Sicherheitsereignisse.