Clés API

Lister les clés API

ApiKeyListPage Organization.ApiKeys.List(parameters, cancellationToken = default)

GET/v1/organizations/api_keys

Récupérer une clé API (Admin API)

ApiKey Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)

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

ApiKey Organization.ApiKeys.Update(parameters, cancellationToken = default)

POST/v1/organizations/api_keys/{api_key_id}

Models

class ApiKey { Type = "api_key"; ID; CreatedAt; /* 7 more */ }

class ApiKeyCreatedBy { Type; ID; }

required Type Type

Type of the actor that created the object.

One of the following:

ServiceAccount("service_account")

User("user")

required string ID

ID of the actor that created the object.

class ApiKeyOrganizationScope { Type = "organization"; }

JsonElement Type = "organization"

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

class ApiKeyServiceAccountActor { Type = "service_account_actor"; ServiceAccountID; }

JsonElement Type = "service_account_actor"

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

required string ServiceAccountID

ID of the Service Account the API key acts as.

class ApiKeyUserActor { Type = "user_actor"; UserID; }

JsonElement Type = "user_actor"

Principal type. Always "user_actor" for a User.

required string UserID

ID of the User the API key acts as.

class ApiKeyWorkspaceScope { Type = "workspace"; WorkspaceID; }

JsonElement Type = "workspace"

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

required string WorkspaceID

ID of the Workspace the API key belongs to, including when it is the organization's default Workspace.