Admin API Übersicht

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 Claude Console erfordern würden.

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.

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": "[email protected]",
    "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 (Konsole), 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 Benutzerzugang zu spezifischen Arbeitsbereichen:

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

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

Zugriff auf Organisationsinformationen

Erhalten Sie Informationen über Ihre Organisation programmatisch mit dem /v1/organizations/me Endpunkt.

Zum Beispiel:

curl "https://api.anthropic.com/v1/organizations/me" \
  --header "anthropic-version: 2023-06-01" \
  --header "x-api-key: $ADMIN_API_KEY"

{
  "id": "12345678-1234-5678-1234-567812345678",
  "type": "organization",
  "name": "Organization Name"
}

Dieser Endpunkt ist nützlich, um programmatisch zu bestimmen, zu welcher Organisation ein Admin API-Schlüssel gehört.

Für vollständige Parameterdetails und Antwortschemas siehe die Organization Info API-Referenz.

Zugriff auf Nutzungs- und Kostenberichte

Um auf Nutzungs- und Kostenberichte für Ihre Organisation zuzugreifen, verwenden Sie die Usage and Cost API-Endpunkte:

• Der Usage-Endpunkt (/v1/organizations/usage_report/messages) bietet detaillierte Nutzungsdaten, einschließlich Token-Anzahlen und Anfragemetriken, gruppiert nach verschiedenen Dimensionen wie Arbeitsbereich, Benutzer und Modell.
• Der Cost-Endpunkt (/v1/organizations/cost_report) bietet Kostendaten, die mit der Nutzung Ihrer Organisation verbunden sind, und ermöglicht es Ihnen, Ausgaben zu verfolgen und Kosten nach Arbeitsbereich oder Beschreibung zuzuordnen.

Diese Endpunkte bieten detaillierte Einblicke in die Nutzung Ihrer Organisation und die damit verbundenen Kosten.

Zugriff auf Claude Code-Analysen

Für Organisationen, die Claude Code verwenden, bietet die Claude Code Analytics API detaillierte Produktivitätsmetriken und Nutzungseinblicke:

• Der Claude Code Analytics-Endpunkt (/v1/organizations/usage_report/claude_code) bietet täglich aggregierte Metriken für die Claude Code-Nutzung, einschließlich Sitzungen, Codezeilen, Commits, Pull Requests, Tool-Nutzungsstatistiken und Kostendaten aufgeschlüsselt nach Benutzer und Modell.

Diese API ermöglicht es Ihnen, die Entwicklerproduktivität zu verfolgen, die Claude Code-Adoption zu analysieren und benutzerdefinierte Dashboards für Ihre Organisation zu erstellen.

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