Claude Platform Docs

Clés API

Lister les clés API
$ ant organization:api-keys list
GET/v1/organizations/api_keys
Récupérer une clé API (Admin API)
$ ant organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}

Récupérez les informations sur une clé API unique de votre organisation, recherchée par son ID. Ce point de terminaison de l'Admin API nécessite une clé Admin API, est destiné à la gestion programmatique des clés et ne renvoie jamais la valeur secrète de la clé. Pour afficher ou créer vos propres clés API, accédez à Clés API dans la Claude Console.

Mettre à jour une clé API
$ ant organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}
Models
api_key: object{ type: "api_key", id, created_at, 7 more }
api_key_created_by: object{ type, id }
type: "service_account" or "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.

api_key_organization_scope: object{ type: "organization" }
type: "organization"

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

api_key_service_account_actor: object{ 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.

api_key_user_actor: object{ 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.

api_key_workspace_scope: object{ 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.