Claude Platform Docs

列出外部金鑰

GET/v1/organizations/external_keys

列出呼叫者組織中的外部金鑰設定。

結果依建立時間排序（最新的在前）。使用回應中的 next_page 游標來擷取後續頁面。

Query parameters
limit: optional number

Number of results per page.

default20
maximum100
minimum1
page: optional string

Opaque cursor from a previous response's next_page.

Returns
data: array of BetaExternalKey { id, attachment, created_at, 5 more }
id: string

Identifier of the external key config. A tagged ID prefixed ekey_, or — for organizations on the Claude Platform on AWS — the AWS KMS key ARN.

attachment: BetaExternalKeyAttachedAttachment { type } or BetaExternalKeyUnattachedAttachment { type }

Whether any workspace uses this config to encrypt its data — counting live and archived workspaces (an archived workspace's data remains encrypted under the config), excluding deleted ones. Only an attached config is used by the encryption path; an unattached config is inert and can be deleted.

One of the following:
BetaExternalKeyAttachedAttachment object{ type }
type: "attached"
defaultattached
BetaExternalKeyUnattachedAttachment object{ type }
type: "unattached"
defaultunattached
created_at: string
formatdate-time
display_name: string or null

Human-friendly display name. Null if none was set.

geo: string

Data residency geo. Selects which regional validator handles this key's encrypt/decrypt roundtrips.

provider_config: BetaAWSExternalKeyConfig { kms_arn, type, region, role_arn } or BetaGCPExternalKeyConfig { key_name, type } or BetaAzureExternalKeyConfig { key_name, tenant_id, type, 2 more }

KMS provider identity and auth coordinates.

One of the following:
BetaAWSExternalKeyConfig object{ kms_arn, type, region, role_arn }
kms_arn: string

Full ARN of the AWS KMS key. On Claude Platform on AWS the key must be a single-Region key in your organization's own AWS account; cross-account keys, multi-Region keys, and alias ARNs are rejected.

maxLength2048
type: "aws"
region: optional string or null

AWS region. Derived from kms_arn if omitted.

role_arn: optional string or null⁠Deprecated

IAM role ARN. Deprecated — Anthropic reaches the KMS key through its own intermediate role (or, on Claude Platform on AWS, with credentials AWS issues for the Workspace); this field is ignored.

BetaGCPExternalKeyConfig object{ key_name, type }
key_name: string

Full resource name of the Cloud KMS key.

type: "gcp"
BetaAzureExternalKeyConfig object{ key_name, tenant_id, type, 2 more }
key_name: string

Name of the key within the vault.

tenant_id: string

Azure AD tenant ID.

type: "azure"
vault_uri: string

Key Vault data-plane URI — https://{vault-name}.vault.azure.net or https://{hsm-name}.managedhsm.azure.net.

client_id: optional string or null

Azure AD application (client) ID. Omit to use Anthropic's multitenant app. Provide only if using a single-tenant app registration in the customer's directory.

type: "external_key"
defaultexternal_key
updated_at: string
formatdate-time
next_page: string or null

Opaque cursor for the next page, or null if no more results. Pass as ?page= to fetch the next page.

列出外部金鑰
curl https://api.anthropic.com/v1/organizations/external_keys \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"
Returns Examples
Response 200
{
  "data": [
    {
      "id": "ekey_01SDCCSbTxrXDpWc1phhtcfK",
      "attachment": {
        "type": "attached"
      },
      "created_at": "2024-10-30T23:58:27.427722Z",
      "display_name": "prod-us-key",
      "geo": "us",
      "provider_config": {
        "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
        "type": "aws",
        "region": "us-east-1",
        "role_arn": "arn:aws:iam::111122223333:role/anthropic-cmek"
      },
      "type": "external_key",
      "updated_at": "2024-10-30T23:58:27.427722Z"
    }
  ],
  "next_page": "next_page"
}