Claude Platform Docs

Chiavi API

Elenca le chiavi API
beta.organization.api_keys.list(**kwargs) -> Page<BetaAPIKey>
GET/v1/organizations/api_keys
Recupera chiave API (Admin API)
beta.organization.api_keys.retrieve(api_key_id) -> BetaAPIKey
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
beta.organization.api_keys.update(api_key_id, **kwargs) -> BetaAPIKey
POST/v1/organizations/api_keys/{api_key_id}
Models
class BetaAPIKey { type: :api_key, id, created_at, 8 more }
class BetaAPIKeyCreatedBy { type, id }
type: :service_account | :user

Type of the actor that created the object.

One of the following:
:service_account
:user
id: String

ID of the actor that created the object.

class BetaAPIKeyOrganizationScope { type: :organization }
type: :organization

Scope type. Always "organization": the API key has no Workspace. Only a principal-bound API key can have this scope.

class BetaAPIKeyServiceAccountActor { type: :service_account_actor, service_account_id }
type: :service_account_actor

Principal type. Always "service_account_actor" for a Service Account.

service_account_id: String

ID of the Service Account the API key acts as.

class BetaAPIKeyUserActor { type: :user_actor, user_id }
type: :user_actor

Principal type. Always "user_actor" for a User.

user_id: String

ID of the User the API key acts as.

class BetaAPIKeyWorkspaceScope { type: :workspace, workspace_id }
type: :workspace

Scope type. Always "workspace": the API key belongs to one Workspace.

workspace_id: String

ID of the Workspace the API key belongs to. Unlike the deprecated top-level workspace_id, this is the Workspace's real ID even for the organization's default Workspace.