API-Schlüssel
Erstellen und widerrufen Sie Anmeldeinformationen für Organisationen für den programmgesteuerten Zugriff.
Ein API-Schlüssel ermöglicht einem Programm den Zugriff auf eine Organisation. Ciele speichert nur den Hash des Secrets.
Einen Schlüssel erstellen
- Öffnen Sie Settings.
- Wählen Sie API Keys.
- Wählen Sie Create API key.
- Geben Sie einen Namen für den Schlüssel ein.
- Wählen Sie die mindestens erforderliche Rolle aus.
- Kopieren Sie das Secret in einen sicheren Anmeldedatenspeicher.
Ciele zeigt das ciele_sk_...-Geheimnis einmal an. Sie können dasselbe Secret
später nicht mehr abrufen.
Die ausgewählte Rolle darf nicht höher sein als Ihre eigene Rolle. Ciele prüft die Rolle bei jeder API-Operation.
Einen Schlüssel widerrufen
- Öffnen Sie Settings > API Keys.
- Suchen Sie den Schlüssel.
- Wählen Sie Revoke.
- Bestätigen Sie die Aktion.
Durch den Widerruf werden neue Anfragen, die den Schlüssel verwenden, gestoppt. Ciele führt den Schlüsseldatensatz für Audit-Informationen.
Protect the secret
Do not put an API key in source control, public logs, prompts, or screenshots. Use an environment variable or a secret store.