Panoramica dell'API Admin
The Admin API is unavailable for individual accounts. To collaborate with teammates and add members, set up your organization in Console → Settings → Organization.
L'API Admin ti consente di gestire programmaticamente le risorse della tua organizzazione, inclusi i membri dell'organizzazione, gli spazi di lavoro e le chiavi API. Questo fornisce controllo programmatico su attività amministrative che altrimenti richiederebbero configurazione manuale nella Console Claude.
L'API Admin richiede accesso speciale
L'API Admin richiede una chiave API Admin speciale (che inizia con sk-ant-admin...) che differisce dalle chiavi API standard. Solo i membri dell'organizzazione con ruolo admin possono fornire chiavi API Admin attraverso la Console Claude.
Come funziona l'API Admin
Quando usi l'API Admin:
- Fai richieste usando la tua chiave API Admin nell'header
x-api-key - L'API ti consente di gestire:
- Membri dell'organizzazione e i loro ruoli
- Inviti dei membri dell'organizzazione
- Spazi di lavoro e i loro membri
- Chiavi API
Questo è utile per:
- Automatizzare l'onboarding/offboarding degli utenti
- Gestire programmaticamente l'accesso agli spazi di lavoro
- Monitorare e gestire l'utilizzo delle chiavi API
Ruoli e permessi dell'organizzazione
Ci sono cinque ruoli a livello di organizzazione. Vedi maggiori dettagli qui.
| Ruolo | Permessi |
|---|---|
| user | Può usare Workbench |
| claude_code_user | Può usare Workbench e Claude Code |
| developer | Può usare Workbench e gestire le chiavi API |
| billing | Può usare Workbench e gestire i dettagli di fatturazione |
| admin | Può fare tutto quanto sopra, più gestire gli utenti |
Concetti chiave
Membri dell'Organizzazione
Puoi elencare i membri dell'organizzazione, aggiornare i ruoli dei membri e rimuovere membri.
# Elenca membri dell'organizzazione
curl "https://api.anthropic.com/v1/organizations/users?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# Aggiorna ruolo membro
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"}'
# Rimuovi membro
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"Inviti dell'Organizzazione
Puoi invitare utenti alle organizzazioni e gestire quegli inviti.
# Crea invito
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"
}'
# Elenca inviti
curl "https://api.anthropic.com/v1/organizations/invites?limit=10" \
--header "anthropic-version: 2023-06-01" \
--header "x-api-key: $ANTHROPIC_ADMIN_KEY"
# Elimina invito
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"Spazi di Lavoro
Crea e gestisci spazi di lavoro (console) per organizzare le tue risorse:
# Crea spazio di lavoro
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"}'
# Elenca spazi di lavoro
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"
# Archivia spazio di lavoro
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"Membri dello Spazio di Lavoro
Gestisci l'accesso degli utenti a spazi di lavoro specifici:
# Aggiungi membro allo spazio di lavoro
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"
}'
# Elenca membri dello spazio di lavoro
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"
# Aggiorna ruolo membro
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"
}'
# Rimuovi membro dallo spazio di lavoro
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"Chiavi API
Monitora e gestisci chiavi API:
# Elenca chiavi API
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"
# Aggiorna chiave API
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"
}'Accesso alle informazioni dell'organizzazione
Ottieni informazioni sulla tua organizzazione programmaticamente con l'endpoint /v1/organizations/me.
Per esempio:
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"
}Questo endpoint è utile per determinare programmaticamente a quale organizzazione appartiene una chiave API Admin.
Per dettagli completi sui parametri e schemi di risposta, vedi il riferimento API delle Informazioni dell'Organizzazione.
Accesso ai report di utilizzo e costi
Per accedere ai report di utilizzo e costi per la tua organizzazione, usa gli endpoint dell'API Utilizzo e Costi:
- L'endpoint Utilizzo (
/v1/organizations/usage_report/messages) fornisce dati dettagliati sull'utilizzo, inclusi conteggi di token e metriche di richiesta, raggruppati per varie dimensioni come spazio di lavoro, utente e modello. - L'endpoint Costi (
/v1/organizations/cost_report) fornisce dati sui costi associati all'utilizzo della tua organizzazione, permettendoti di tracciare le spese e allocare i costi per spazio di lavoro o descrizione.
Questi endpoint forniscono approfondimenti dettagliati sull'utilizzo della tua organizzazione e sui costi associati.
Accesso alle analisi di Claude Code
Per le organizzazioni che usano Claude Code, l'API di Analisi di Claude Code fornisce metriche dettagliate di produttività e approfondimenti sull'utilizzo:
- L'endpoint di Analisi di Claude Code (
/v1/organizations/usage_report/claude_code) fornisce metriche aggregate giornaliere per l'utilizzo di Claude Code, incluse sessioni, righe di codice, commit, pull request, statistiche di utilizzo degli strumenti e dati sui costi suddivisi per utente e modello.
Questa API ti consente di tracciare la produttività degli sviluppatori, analizzare l'adozione di Claude Code e costruire dashboard personalizzate per la tua organizzazione.
Migliori pratiche
Per usare efficacemente l'API Admin:
- Usa nomi e descrizioni significativi per spazi di lavoro e chiavi API
- Implementa gestione appropriata degli errori per operazioni fallite
- Controlla regolarmente i ruoli e permessi dei membri
- Pulisci spazi di lavoro inutilizzati e inviti scaduti
- Monitora l'utilizzo delle chiavi API e ruota le chiavi periodicamente