API-Keys

API-Keys auflisten

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

GET/v1/organizations/api_keys

API-Key abrufen (Admin API)

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

GET/v1/organizations/api_keys/{api_key_id}

Ruft Informationen über einen einzelnen API-Key in deiner Organisation ab, der anhand seiner ID gesucht wird. Dieser Admin-API-Endpunkt erfordert einen Admin-API-Key, ist für die programmatische Key-Verwaltung vorgesehen und gibt niemals den geheimen Wert des Keys zurück. Um deine eigenen API-Keys anzuzeigen oder zu erstellen, gehe in der Claude Console zu API-Keys.

API-Key aktualisieren

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.