Verwendung der Admin API

The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.

Die Admin API ermöglicht es Ihnen, die Ressourcen Ihrer Organisation programmatisch zu verwalten, einschließlich Organisationsmitgliedern, Arbeitsbereichen und API-Schlüsseln. Dies bietet programmatische Kontrolle über administrative Aufgaben, die andernfalls eine manuelle Konfiguration in der Anthropic Console erfordern würden.

Die Admin API erfordert besonderen Zugang

Die Admin API erfordert 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:

1. Sie stellen Anfragen mit Ihrem Admin API-Schlüssel im x-api-key Header
2. Die API ermöglicht es Ihnen zu verwalten:
   • Organisationsmitglieder und ihre Rollen
   • Einladungen für Organisationsmitglieder
   • Arbeitsbereiche und ihre Mitglieder
   • API-Schlüssel

Dies ist nützlich für:

• Automatisierung des Benutzer-Onboardings/Offboardings
• Programmatische Verwaltung des Arbeitsbereich-Zugangs
• Überwachung und Verwaltung der API-Schlüssel-Nutzung

Organisationsrollen und Berechtigungen

Es gibt fünf Rollen auf Organisationsebene. Weitere Details finden Sie hier.

Rolle	Berechtigungen
user	Kann Workbench verwenden
claude_code_user	Kann Workbench und Claude Code verwenden
developer	Kann Workbench verwenden und API-Schlüssel verwalten
billing	Kann Workbench verwenden und Abrechnungsdetails verwalten
admin	Kann alles oben Genannte plus Benutzer verwalten

Schlüsselkonzepte

Organisationsmitglieder

Sie können Organisationsmitglieder auflisten, Mitgliederrollen aktualisieren und Mitglieder entfernen.

Shell

# Organisationsmitglieder auflisten
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Mitgliederrolle aktualisieren
curl "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"role": "developer"}'

# Mitglied entfernen
curl --request DELETE "https://api.anthropic.com/v1/organizations/users/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Organisationseinladungen

Sie können Benutzer zu Organisationen einladen und diese Einladungen verwalten.

Shell

# Einladung erstellen
curl --request POST "https://api.anthropic.com/v1/organizations/invites" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "email": "[e-mail]",
    "role": "developer"
  }'

# Einladungen auflisten
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Einladung löschen
curl --request DELETE "https://api.anthropic.com/v1/organizations/invites/{invite_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Arbeitsbereiche

Erstellen und verwalten Sie Arbeitsbereiche (Console), um Ihre Ressourcen zu organisieren:

Shell

# Arbeitsbereich erstellen
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{"name": "Production"}'

# Arbeitsbereiche auflisten
curl "https://api.anthropic.com/v1/organizations/workspaces?limit=10&include_archived=false" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Arbeitsbereich archivieren
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/archive" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

Arbeitsbereich-Mitglieder

Verwalten Sie Benutzerzugang zu spezifischen Arbeitsbereichen:

Shell

# Mitglied zu Arbeitsbereich hinzufügen
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "user_id": "user_xxx",
    "workspace_role": "workspace_developer"
  }'

# Arbeitsbereich-Mitglieder auflisten
curl "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members?limit=10" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# Mitgliederrolle aktualisieren
curl --request POST "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "workspace_role": "workspace_admin"
  }'

# Mitglied aus Arbeitsbereich entfernen
curl --request DELETE "https://api.anthropic.com/v1/organizations/workspaces/{workspace_id}/members/{user_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

API-Schlüssel

Überwachen und verwalten Sie API-Schlüssel:

Shell

# API-Schlüssel auflisten
curl "https://api.anthropic.com/v1/organizations/api_keys?limit=10&status=active&workspace_id=wrkspc_xxx" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY"

# API-Schlüssel aktualisieren
curl --request POST "https://api.anthropic.com/v1/organizations/api_keys/{api_key_id}" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ANTHROPIC_ADMIN_KEY" \
  --data '{
    "status": "inactive",
    "name": "New Key Name"
  }'

Best Practices

Um die Admin API effektiv zu nutzen:

• Verwenden Sie aussagekräftige Namen und Beschreibungen für Arbeitsbereiche und API-Schlüssel
• Implementieren Sie ordnungsgemäße Fehlerbehandlung für fehlgeschlagene Operationen
• Überprüfen Sie regelmäßig Mitgliederrollen und Berechtigungen
• Räumen Sie ungenutzte Arbeitsbereiche und abgelaufene Einladungen auf
• Überwachen Sie die API-Schlüssel-Nutzung und rotieren Sie Schlüssel regelmäßig

FAQ

Welche Berechtigungen werden benötigt, um die Admin API zu verwenden?

Nur Organisationsmitglieder mit der Admin-Rolle können die Admin API verwenden. Sie müssen auch einen speziellen Admin API-Schlüssel haben (beginnend mit sk-ant-admin).

Kann ich neue API-Schlüssel über die Admin API erstellen?

Nein, neue API-Schlüssel können aus Sicherheitsgründen nur über die Anthropic Console erstellt werden. Die Admin API kann nur bestehende API-Schlüssel verwalten.

Was passiert mit API-Schlüsseln beim Entfernen eines Benutzers?

API-Schlüssel bleiben in ihrem aktuellen Zustand bestehen, da sie auf die Organisation und nicht auf einzelne Benutzer beschränkt sind.

Können Organisationsadministratoren über die API entfernt werden?

Nein, Organisationsmitglieder mit der Admin-Rolle können aus Sicherheitsgründen nicht über die API entfernt werden.

Wie lange sind Organisationseinladungen gültig?

Organisationseinladungen laufen nach 21 Tagen ab. Es gibt derzeit keine Möglichkeit, diese Ablaufzeit zu ändern.

Gibt es Limits für Arbeitsbereiche?

Ja, Sie können maximal 100 Arbeitsbereiche pro Organisation haben. Archivierte Arbeitsbereiche zählen nicht zu diesem Limit.

Was ist der Standard-Arbeitsbereich?

Jede Organisation hat einen “Standard-Arbeitsbereich”, der nicht bearbeitet oder entfernt werden kann und keine ID hat. Dieser Arbeitsbereich erscheint nicht in den Arbeitsbereich-Listen-Endpunkten.

Wie wirken sich Organisationsrollen auf den Arbeitsbereich-Zugang aus?

Organisationsadministratoren erhalten automatisch die workspace_admin Rolle für alle Arbeitsbereiche. Organisationsabrechnungsmitglieder erhalten automatisch die workspace_billing Rolle. Organisationsbenutzer und Entwickler müssen manuell zu jedem Arbeitsbereich hinzugefügt werden.

Welche Rollen können in Arbeitsbereichen zugewiesen werden?

Organisationsbenutzer und Entwickler können die Rollen workspace_admin, workspace_developer oder workspace_user zugewiesen bekommen. Die workspace_billing Rolle kann nicht manuell zugewiesen werden - sie wird durch das Haben der Organisations-billing Rolle vererbt.

Können die Arbeitsbereich-Rollen von Organisationsadministratoren oder Abrechnungsmitgliedern geändert werden?

Nur Organisationsabrechnungsmitglieder können ihre Arbeitsbereich-Rolle auf eine Admin-Rolle hochgestuft bekommen. Ansonsten können Organisationsadministratoren und Abrechnungsmitglieder ihre Arbeitsbereich-Rollen nicht ändern lassen oder aus Arbeitsbereichen entfernt werden, solange sie diese Organisationsrollen innehaben. Ihr Arbeitsbereich-Zugang muss durch eine vorherige Änderung ihrer Organisationsrolle modifiziert werden.

Was passiert mit dem Arbeitsbereich-Zugang, wenn sich Organisationsrollen ändern?

Wenn ein Organisationsadministrator oder Abrechnungsmitglied zu Benutzer oder Entwickler herabgestuft wird, verliert er den Zugang zu allen Arbeitsbereichen außer denen, wo ihm manuell Rollen zugewiesen wurden. Wenn Benutzer zu Admin- oder Abrechnungsrollen befördert werden, erhalten sie automatischen Zugang zu allen Arbeitsbereichen.