Verwaltung und Überwachung

Admin API-Übersicht

Verwalten Sie Ihre Organisationsressourcen programmatisch mit 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 Organisationsmitglieder, Arbeitsbereiche und API-Schlüssel. Dies bietet programmatische Kontrolle über administrative Aufgaben, die sonst eine manuelle Konfiguration in der Claude Console erfordern würden.

Die Admin API erfordert speziellen Zugriff

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 Claude Console bereitstellen.

Wie die Admin API funktioniert

Wenn Sie die Admin API verwenden:

Sie stellen 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 ihre Mitglieder
- API-Schlüssel

Dies ist nützlich für:

Automatisierung des Benutzer-Onboarding/Offboarding
Programmatische Verwaltung des Arbeitsbereichszugriffs
Überwachung und Verwaltung der API-Schlüsselnutzung

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 tun, plus Benutzer verwalten

Wichtige Konzepte

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

Eine umfassende Anleitung zu Arbeitsbereichen finden Sie unter Arbeitsbereiche.

Erstellen und verwalten Sie Arbeitsbereiche (Konsole), 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"

Arbeitsbereichsmitglieder

Verwalten Sie Benutzerzugriff auf bestimmte Arbeitsbereiche:

Shell

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

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

Zugriff auf Organisationsinformationen

Rufen Sie Informationen über Ihre Organisation programmatisch mit dem /v1/organizations/me-Endpunkt ab.

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.

Vollständige Parameterdetails und Antwortschemas finden Sie in der Organisations-Info-API-Referenz.

Zugriff auf Nutzungs- und Kostenberichte

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

Der Nutzungsendpunkt (/v1/organizations/usage_report/messages) bietet detaillierte Nutzungsdaten, einschließlich Token-Zählungen und Anfragemetriken, gruppiert nach verschiedenen Dimensionen wie Arbeitsbereich, Benutzer und Modell.
Der Kostenendpunkt (/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 und die damit verbundenen Kosten Ihrer Organisation.

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-Einführung 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
Bereinigen Sie ungenutzte Arbeitsbereiche und abgelaufene Einladungen
Überwachen Sie die API-Schlüsselnutzung und rotieren Sie Schlüssel regelmäßig

Häufig gestellte Fragen

Was this page helpful?

Verwaltung und Überwachung

Admin API-Übersicht

Verwalten Sie Ihre Organisationsressourcen programmatisch mit 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 erfordert speziellen Zugriff

Wie die Admin API funktioniert

Wenn Sie die Admin API verwenden:

Sie stellen 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 ihre Mitglieder
- API-Schlüssel

Dies ist nützlich für:

Automatisierung des Benutzer-Onboarding/Offboarding
Programmatische Verwaltung des Arbeitsbereichszugriffs
Überwachung und Verwaltung der API-Schlüsselnutzung

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 tun, plus Benutzer verwalten

Wichtige Konzepte

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

Eine umfassende Anleitung zu Arbeitsbereichen finden Sie unter Arbeitsbereiche.

Erstellen und verwalten Sie Arbeitsbereiche (Konsole), 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"

Arbeitsbereichsmitglieder

Verwalten Sie Benutzerzugriff auf bestimmte Arbeitsbereiche:

Shell

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

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

Zugriff auf Organisationsinformationen

Rufen Sie Informationen über Ihre Organisation programmatisch mit dem /v1/organizations/me-Endpunkt ab.

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.

Vollständige Parameterdetails und Antwortschemas finden Sie in der Organisations-Info-API-Referenz.

Zugriff auf Nutzungs- und Kostenberichte

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

Der Nutzungsendpunkt (/v1/organizations/usage_report/messages) bietet detaillierte Nutzungsdaten, einschließlich Token-Zählungen und Anfragemetriken, gruppiert nach verschiedenen Dimensionen wie Arbeitsbereich, Benutzer und Modell.
Der Kostenendpunkt (/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 und die damit verbundenen Kosten Ihrer Organisation.

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-Einführung 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
Bereinigen Sie ungenutzte Arbeitsbereiche und abgelaufene Einladungen
Überwachen Sie die API-Schlüsselnutzung und rotieren Sie Schlüssel regelmäßig

Häufig gestellte Fragen

Was this page helpful?

Wie die Admin API funktioniert

Organisationsrollen und Berechtigungen

Wichtige Konzepte

Organisationsmitglieder

Organisationseinladungen

Arbeitsbereiche

Arbeitsbereichsmitglieder

API-Schlüssel

Zugriff auf Organisationsinformationen

Zugriff auf Nutzungs- und Kostenberichte

Zugriff auf Claude Code-Analysen

Best Practices

Häufig gestellte Fragen

Welche Berechtigungen sind erforderlich, um die Admin API zu verwenden?

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

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

Können Organisations-Admins über die API entfernt werden?

Wie lange sind Organisationseinladungen gültig?

Gibt es Limits für Arbeitsbereiche?

Was ist der Standard-Arbeitsbereich?

Wie beeinflussen Organisationsrollen den Arbeitsbereichszugriff?

Welche Rollen können in Arbeitsbereichen zugewiesen werden?

Können die Arbeitsbereichsrollen von Organisations-Admins oder Abrechnungsmitgliedern geändert werden?

Was passiert mit dem Arbeitsbereichszugriff, wenn sich Organisationsrollen ändern?

Wie die Admin API funktioniert

Organisationsrollen und Berechtigungen

Wichtige Konzepte

Organisationsmitglieder

Organisationseinladungen

Arbeitsbereiche

Arbeitsbereichsmitglieder

API-Schlüssel

Zugriff auf Organisationsinformationen

Zugriff auf Nutzungs- und Kostenberichte

Zugriff auf Claude Code-Analysen

Best Practices

Häufig gestellte Fragen

Welche Berechtigungen sind erforderlich, um die Admin API zu verwenden?

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

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

Können Organisations-Admins über die API entfernt werden?

Wie lange sind Organisationseinladungen gültig?

Gibt es Limits für Arbeitsbereiche?

Was ist der Standard-Arbeitsbereich?

Wie beeinflussen Organisationsrollen den Arbeitsbereichszugriff?

Welche Rollen können in Arbeitsbereichen zugewiesen werden?

Können die Arbeitsbereichsrollen von Organisations-Admins oder Abrechnungsmitgliedern geändert werden?

Was passiert mit dem Arbeitsbereichszugriff, wenn sich Organisationsrollen ändern?