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 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:

  1. Sie senden Anfragen mit Ihrem Admin-API-Schlüssel im x-api-key Header
  2. Die API ermöglicht es Ihnen, Folgendes zu verwalten:
    • Organisationsmitglieder und deren 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.

RolleBerechtigungen
userKann Workbench nutzen
developerKann Workbench nutzen und API-Schlüssel verwalten
billingKann Workbench nutzen und Abrechnungsdetails verwalten
adminKann alles oben Genannte tun, plus Benutzer verwalten

​
Schlüsselkonzepte

​
Organisationsmitglieder

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

# 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.

# 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": "newuser@domain.com",
    "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, um Ihre Ressourcen zu organisieren:

# 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"

​
Arbeitsbereichsmitglieder

Verwalten Sie den Benutzerzugriff auf bestimmte Arbeitsbereiche:

# Mitglied zum 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"
  }'

# Arbeitsbereichsmitglieder 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:

# 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"
  }'

​
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

​
FAQ

Was this page helpful?

EmbeddingsGlossar