Claude Platform Docs

Organizzazione

Ottieni l'organizzazione corrente
OrganizationInfo organization().retrieve(params = OrganizationRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/me

Recupera le informazioni sull'organizzazione associata alla chiave API autenticata.

Models
class OrganizationInfo { type = "organization"; id; name; }
JsonValue type = "organization"

Object type.

For Organizations, this is always "organization".

String id

ID of the Organization.

formatuuid
String name

Name of the Organization.

enum OrganizationRole
ADMIN("admin")
BILLING("billing")
CLAUDE_CODE_USER("claude_code_user")
DEVELOPER("developer")
MANAGED("managed")
MEMBERSHIP_ADMIN("membership_admin")
OWNER("owner")
PRIMARY_OWNER("primary_owner")
USER("user")

OrganizzazioneChiavi API

Elenca le chiavi API
ApiKeyListPage organization().apiKeys().list(params = ApiKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys
Recupera chiave API (Admin API)
ApiKey organization().apiKeys().retrieve(params = ApiKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys/{api_key_id}

Recupera le informazioni su una singola chiave API della tua organizzazione, cercata tramite il suo ID. Questo endpoint dell'Admin API richiede una chiave Admin API, è pensato per la gestione programmatica delle chiavi e non restituisce mai il valore segreto della chiave. Per visualizzare o creare le tue chiavi API, vai su Chiavi API nella Claude Console.

Aggiorna chiave API
ApiKey organization().apiKeys().update(params = ApiKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/api_keys/{api_key_id}

OrganizzazioneChiavi esterne

Crea chiave esterna
ExternalKey organization().externalKeys().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys

Crea una configurazione di chiave esterna di proprietà dell'organizzazione del chiamante.

Elenca le chiavi esterne
ExternalKeyListPage organization().externalKeys().list(params = ExternalKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/external_keys

Elenca le configurazioni di chiavi esterne nell'organizzazione del chiamante.

Ottieni chiave esterna
ExternalKey organization().externalKeys().retrieve(params = ExternalKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/external_keys/{external_key_id}

Recupera una singola configurazione di chiave esterna nell'organizzazione del chiamante tramite ID.

Aggiorna chiave esterna
ExternalKey organization().externalKeys().update(params = ExternalKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}

Aggiorna parzialmente una configurazione di chiave esterna. I campi omessi restano invariati.

Elimina chiave esterna
ExternalKeyDeleteResponse organization().externalKeys().delete(params = ExternalKeyDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/external_keys/{external_key_id}

Elimina una configurazione di chiave esterna.

Convalida chiave esterna
ExternalKeyValidateResponse organization().externalKeys().validate(params = ExternalKeyValidateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}/validate

Convalida una configurazione di chiave esterna rispetto al KMS del cliente.

OrganizzazioneFederazioneEmittenti

Crea emittente di federazione
FederationIssuer organization().federation().issuers().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Elenca gli emittenti di federazione
IssuerListPage organization().federation().issuers().list(params = IssuerListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Ottieni emittente di federazione
FederationIssuer organization().federation().issuers().retrieve(params = IssuerRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Aggiorna emittente di federazione
FederationIssuer organization().federation().issuers().update(params = IssuerUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Archivia emittente di federazione
FederationIssuer organization().federation().issuers().archive(params = IssuerArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

OrganizzazioneFederazioneRegole

Crea regola di federazione
FederationRule organization().federation().rules().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Elenca le regole di federazione
RuleListPage organization().federation().rules().list(params = RuleListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Ottieni regola di federazione
FederationRule organization().federation().rules().retrieve(params = RuleRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Aggiorna regola di federazione
FederationRule organization().federation().rules().update(params = RuleUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Archivia regola di federazione
FederationRule organization().federation().rules().archive(params = RuleArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

OrganizzazioneFederazioneRegoleWorkspace

Aggiungi workspace alla regola di federazione
FederationRuleWorkspace organization().federation().rules().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Elenca i workspace della regola di federazione
WorkspaceListPage organization().federation().rules().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Rimuovi workspace dalla regola di federazione
WorkspaceRemoveResponse organization().federation().rules().workspaces().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

OrganizzazioneInviti

Crea invito
OrganizationInvite organization().invites().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/invites

Invita un utente a unirsi all'organizzazione tramite email.

Elenca gli inviti
InviteListPage organization().invites().list(params = InviteListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/invites

Elenca gli inviti dell'organizzazione.

Ottieni invito
OrganizationInvite organization().invites().retrieve(params = InviteRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/invites/{invite_id}

Recupera un invito tramite ID.

Elimina invito
InviteDeleteResponse organization().invites().delete(params = InviteDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/invites/{invite_id}

Elimina un invito in sospeso.

OrganizzazioneAccount di servizio

Crea account di servizio
ServiceAccount organization().serviceAccounts().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Elenca gli account di servizio
ServiceAccountListPage organization().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Ottieni account di servizio
ServiceAccount organization().serviceAccounts().retrieve(params = ServiceAccountRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Aggiorna account di servizio
ServiceAccount organization().serviceAccounts().update(params = ServiceAccountUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Archivia account di servizio
ServiceAccount organization().serviceAccounts().archive(params = ServiceAccountArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/archive

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

OrganizzazioneAccount di servizioWorkspace

Aggiungi workspace all'account di servizio
ServiceAccountWorkspaceMember organization().serviceAccounts().workspaces().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Elenca i workspace dell'account di servizio
WorkspaceListPage organization().serviceAccounts().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Rimuovi workspace dall'account di servizio
WorkspaceRemoveResponse organization().serviceAccounts().workspaces().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

OrganizzazioneUtenti

Elenca gli utenti
UserListPage organization().users().list(params = UserListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/users

Elenca i membri dell'organizzazione.

Ottieni utente
OrganizationUser organization().users().retrieve(params = UserRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/users/{user_id}

Recupera un membro dell'organizzazione tramite ID utente.

Aggiorna utente
OrganizationUser organization().users().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/users/{user_id}

Aggiorna il ruolo di un membro nell'organizzazione.

Rimuovi utente
UserRemoveResponse organization().users().remove(params = UserRemoveParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/users/{user_id}

Rimuovi un membro dall'organizzazione.

OrganizzazioneWorkspace

Elenca i workspace
WorkspaceListPage organization().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces
Crea workspace
Workspace organization().workspaces().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces
Ottieni workspace
Workspace organization().workspaces().retrieve(params = WorkspaceRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}
Aggiorna workspace
Workspace organization().workspaces().update(params = WorkspaceUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}
Archivia workspace
Workspace organization().workspaces().archive(params = WorkspaceArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganizzazioneWorkspaceLimiti di velocità

Elenca i limiti di velocità del workspace
RateLimitListPage organization().workspaces().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Elenca i "rate limit" (limiti di velocità) di un workspace.

OrganizzazioneWorkspaceMembri

Elenca i membri del workspace
MemberListPage organization().workspaces().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members
Crea membro del workspace
WorkspaceMember organization().workspaces().members().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members
Ottieni membro del workspace
WorkspaceMember organization().workspaces().members().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Aggiorna membro del workspace
WorkspaceMember organization().workspaces().members().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Elimina membro del workspace
MemberRemoveResponse organization().workspaces().members().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganizzazioneWorkspaceAccount di servizio

Elenca gli account di servizio membri del workspace
ServiceAccountListPage organization().workspaces().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Crea account di servizio membro del workspace
ServiceAccountWorkspaceMember organization().workspaces().serviceAccounts().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Ottieni account di servizio membro del workspace
ServiceAccountWorkspaceMember organization().workspaces().serviceAccounts().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Aggiorna account di servizio membro del workspace
ServiceAccountWorkspaceMember organization().workspaces().serviceAccounts().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi Admin API non sono accettate. Consulta Gestire WIF con l'Admin API.

Elimina account di servizio membro del workspace
ServiceAccountRemoveResponse organization().workspaces().serviceAccounts().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Richiede un token di accesso OAuth con lo scope org:admin, ottenuto da ant auth login --scope org:admin o da una regola di workload identity federation; le chiavi API Admin non sono accettate. Consulta Gestire WIF con l'Admin API.

OrganizzazioneLimiti di velocità

Elenca i limiti di velocità dell'organizzazione
RateLimitListPage organization().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rate_limits

Elenca i "rate limit" (limiti di velocità) della Messages API per la tua organizzazione.

Ottieni le impostazioni di conformità
OrganizationComplianceSettings organization().complianceSettings().retrieve(params = ComplianceSettingRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/compliance_settings

Recupera le impostazioni di conformità (Compliance Settings) della tua organizzazione.

Aggiorna le impostazioni di conformità
OrganizationComplianceSettings organization().complianceSettings().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/compliance_settings

Aggiorna le impostazioni di conformità (Compliance Settings) della tua organizzazione.