Admin-API
Die Admin-API ermöglicht es Ihnen, die Ressourcen Ihrer Organisation programmatisch zu verwalten, einschließlich Organisationsmitglieder, Arbeitsbereiche und API-Schlüssel. Dies bietet programmatische Kontrolle über administrative Aufgaben, die sonst eine manuelle Konfiguration in der Anthropic Console erfordern würden.
Die Admin-API erfordert speziellen Zugriff
Die Admin-API benötigt einen speziellen Admin-API-Schlüssel (beginnend mit sk-ant-admin...
), der sich von Standard-API-Schlüsseln unterscheidet. Nur Organisationsmitglieder mit der Admin-Rolle können Admin-API-Schlüssel über die Anthropic Console bereitstellen.
Wie die Admin-API funktioniert
Wenn Sie die Admin-API verwenden:
- Sie senden Anfragen mit Ihrem Admin-API-Schlüssel im
x-api-key
Header - Die API ermöglicht es Ihnen, Folgendes zu verwalten:
- Organisationsmitglieder und ihre Rollen
- Einladungen für Organisationsmitglieder
- Arbeitsbereiche und deren Mitglieder
- API-Schlüssel
Dies ist nützlich für:
- Automatisierung von Benutzer-Onboarding/Offboarding
- Programmatische Verwaltung des Arbeitsbereichszugriffs
- Überwachung und Verwaltung der API-Schlüssel-Nutzung
Organisationsrollen und Berechtigungen
Es gibt vier Rollen auf Organisationsebene.
Rolle | Berechtigungen |
---|---|
user | Kann Workbench nutzen |
developer | Kann Workbench nutzen und API-Schlüssel verwalten |
billing | Kann Workbench nutzen und Abrechnungsdetails verwalten |
admin | Kann alles oben Genannte tun, plus Benutzer verwalten |
Schlüsselkonzepte
Organisationsmitglieder
Sie können Organisationsmitglieder auflisten, Mitgliederrollen aktualisieren und Mitglieder entfernen.
Organisationseinladungen
Sie können Benutzer zu Organisationen einladen und diese Einladungen verwalten.
Arbeitsbereiche
Erstellen und verwalten Sie Arbeitsbereiche zur Organisation Ihrer Ressourcen:
Arbeitsbereichsmitglieder
Verwalten Sie den Benutzerzugriff auf bestimmte Arbeitsbereiche:
API-Schlüssel
Überwachen und verwalten Sie API-Schlüssel:
Beste Praktiken
Für die effektive Nutzung der Admin-API:
- Verwenden Sie aussagekräftige Namen und Beschreibungen für Arbeitsbereiche und API-Schlüssel
- Implementieren Sie eine ordnungsgemäße Fehlerbehandlung für fehlgeschlagene Operationen
- Überprüfen Sie regelmäßig Mitgliederrollen und Berechtigungen
- Bereinigen Sie ungenutzte Arbeitsbereiche und abgelaufene Einladungen
- Überwachen Sie die API-Schlüssel-Nutzung und tauschen Sie Schlüssel regelmäßig aus