Claude Platform Docs

外部キーを更新

ExternalKey Organization.ExternalKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}

外部キー設定を部分的に更新します。省略されたフィールドは変更されません。

display_nameは常に編集可能です。geoとprovider_configは、いずれかのワークスペースがこの設定を参照すると 変更できなくなります。以前に暗号化されたデータを復号するには、元のキーIDが必要なためです。

Parameters
ExternalKeyUpdateParams parameters
required string externalKeyID⁠Path parameter

ID of the External Key.

maxLength2048
string? displayName

Human-friendly display name.

minLength1
maxLength255
Geo? geo

Data residency geo. Only us is supported.

Us("us")
ProviderConfig? providerConfig

KMS provider identity and auth coordinates.

class AwsExternalKeyConfig { Type = "aws"; KmsArn; Region; }
JsonElement Type = "aws"
required string KmsArn

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

maxLength2048
string? Region

AWS region. Derived from kms_arn if omitted.

class GcpExternalKeyConfig { Type = "gcp"; KeyName; }
JsonElement Type = "gcp"
required string KeyName

Full resource name of the Cloud KMS key.

class AzureExternalKeyConfigParam { Type = "azure"; KeyName; TenantID; /* 2 more */ }

Azure Key Vault provider configuration.

JsonElement Type = "azure"
required string KeyName

Name of the key within the vault.

required string TenantID

Azure AD tenant ID.

required string VaultUri

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

string? ClientID

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.

Returns
class ExternalKey { Type = "external_key"; ID; Attachment; /* 6 more */ }

CMEK external key config belonging to the caller's organization.

Configs are organization-scoped. Workspaces attach to a config; once any workspace references it, the provider fields become effectively immutable (existing encrypted data needs the config for decrypt).

外部キーを更新
using System;
using Anthropic.Models.Organization.ExternalKeys;

ExternalKeyUpdateParams parameters = new()
{
    ExternalKeyID = "external_key_id"
};

var externalKey = await client.Organization.ExternalKeys.Update(parameters);

Console.WriteLine(externalKey);
Returns Examples
Response 200
{
  "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",
  "user_profile_id": "uprof_01SDCCSbTxrXDpWc1phhtcfK"
}