API-Schlüssel
Unter API-Schlüssel erstellen und verwalten Administratoren Schlüssel, um andere Programme und eigene Tools sicher mit dem RAG-Service zu verbinden – etwa den Windows Syncer, ein Skript, die companyRAG API oder den Ingestion-Endpunkt einer Datensatzsammlung.
Der Bereich erscheint nur für Administratoren von companyRAG (siehe Rechte und Rollen).
Die Übersicht zeigt:
- Name: Der frei gewählte Name des Schlüssels (z. B. „Intranet-Suche”), um ihn später zuzuordnen.
- Erstellt / Zuletzt verwendet: Wann der Schlüssel erstellt und wann er das letzte Mal genutzt wurde.
- Status: Aktiv oder Widerrufen.
- Aktionen: Widerrufen sperrt den Schlüssel sofort und unwiderruflich. Alle damit verknüpften Programme verlieren sofort den Zugriff.
Schlüssel erstellen
Abschnitt mit dem Titel „Schlüssel erstellen“- Neuen Schlüssel erstellen wählen.
- Im Dialog API-Schlüssel erstellen einen Schlüsselname vergeben und Schlüssel erstellen wählen.
- Den Schlüssel im Dialog API-Schlüssel erstellt mit Kopieren übernehmen und an einem sicheren Ort ablegen.
Der Schlüssel beginnt mit rag_ und wird nur einmalig direkt nach der Erstellung komplett angezeigt. Geht er verloren, erstellen Sie einen neuen.
Nutzerbezogener Zugriff
Abschnitt mit dem Titel „Nutzerbezogener Zugriff“Ein API-Schlüssel ist an die Person gebunden, die ihn erstellt hat, und handelt innerhalb der RAG-Verwaltung in deren Namen. Damit gelten für alle Aufrufe genau die Sammlungen und Berechtigungen dieser Person.
Alle Erstellungen und Widerrufe werden im Audit-Protokoll aufgezeichnet. Die verfügbaren Endpunkte beschreibt die companyRAG API-Referenz.