Admin API-Übersicht

Admin-API-Übersicht

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, Workspaces und API-Schlüssel. Dies bietet programmatische Kontrolle über administrative Aufgaben, die sonst 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
- Workspaces und ihre Mitglieder
- API-Schlüssel

Dies ist nützlich für:

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

Organisationsrollen und Berechtigungen

Es gibt fünf Rollen auf Organisationsebene. Weitere Details finden Sie im Artikel API Console-Rollen und Berechtigungen.

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 und Benutzer verwalten

Wichtige Konzepte

Organisationsmitglieder

Sie können Organisationsmitglieder auflisten, Mitgliedsrollen 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"

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

Workspaces

Für einen umfassenden Leitfaden zu Workspaces, einschließlich Console- und API-Beispiele, siehe Workspaces.

Workspace-Mitglieder

Verwalten Sie Benutzerzugriff auf bestimmte Workspaces:

Shell

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

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

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

Für vollständige Parameterdetails und Response-Schemas siehe die Organisations-Info-API-Referenz.

Nutzungs- und Kostenberichte

Verfolgen Sie die Nutzung und Kosten Ihrer Organisation mit der Nutzungs- und Kosten-API.

Claude Code-Analytik

Überwachen Sie die Produktivität von Entwicklern und die Claude Code-Einführung mit der Claude Code Analytics API.

Best Practices

Um die Admin API effektiv zu nutzen:

Verwenden Sie aussagekräftige Namen und Beschreibungen für Workspaces und API-Schlüssel
Implementieren Sie ordnungsgemäße Fehlerbehandlung für fehlgeschlagene Operationen
Überprüfen Sie regelmäßig Mitgliedsrollen und Berechtigungen
Bereinigen Sie ungenutzte Workspaces und abgelaufene Einladungen
Überwachen Sie die API-Schlüsselnutzung und rotieren Sie Schlüssel regelmäßig

Häufig gestellte Fragen

Für Workspace-spezifische Fragen siehe die Workspaces FAQ.

Wie die Admin API funktioniert

Organisationsrollen und Berechtigungen

Wichtige Konzepte

Organisationsmitglieder

Organisationseinladungen

Workspaces

Workspace-Mitglieder

API-Schlüssel

Zugriff auf Organisationsinformationen

Nutzungs- und Kostenberichte

Claude Code-Analytik

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 Organisationsadministratoren über die API entfernt werden?

Wie lange sind Organisationseinladungen gültig?