SPB Git

Repository Public

external_keys.md 27.6 KB


# title: External Keys url: https://platform.claude.com/docs/en/api/beta/organization/external_keys

# External Keys

# Create External Key

POST /v1/organizations/external_keys

Create an external key config owned by the caller's organization.

# Body parameters

  • provider_config: BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam

    KMS provider identity and auth coordinates.

    • BetaAWSExternalKeyConfig object

      • type: "aws"

      • 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.

        maxLength: 2048

      • 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

      • type: "gcp"

      • key_name: string

        Full resource name of the Cloud KMS key.

    • BetaAzureExternalKeyConfigParam object

      Azure Key Vault provider configuration.

      • type: "azure"

      • key_name: string

        Name of the key within the vault.

      • tenant_id: string

        Azure AD tenant ID.

      • 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.

  • display_name: optional string or null

    Human-friendly display name.

    maxLength: 255, minLength: 1

  • geo: optional "us"

    Data residency geo. Only us is supported.

# Returns

  • BetaExternalKey object

    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).

    • type: "external_key"

      default: external_key

    • 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 or BetaExternalKeyUnattachedAttachment

      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.

      • BetaExternalKeyAttachedAttachment object

        • type: "attached"

          default: attached

      • BetaExternalKeyUnattachedAttachment object

        • type: "unattached"

          default: unattached

    • created_at: string

      format: date-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 or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig

      KMS provider identity and auth coordinates.

      • BetaAWSExternalKeyConfig object

        • type: "aws"

        • 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.

          maxLength: 2048

        • 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

        • type: "gcp"

        • key_name: string

          Full resource name of the Cloud KMS key.

      • BetaAzureExternalKeyConfig object

        • type: "azure"

        • key_name: string

          Name of the key within the vault.

        • tenant_id: string

          Azure AD tenant ID.

        • 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.

    • updated_at: string

      format: date-time

# Example

bash
curl https://api.anthropic.com/v1/organizations/external_keys \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{
          "provider_config": {
            "kms_arn": "arn:aws:kms:us-east-1:111122223333:key/abcd1234-5678-90ab-cdef-000011112222",
            "type": "aws"
          }
        }'

# Response (200)

json
{
  "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"
}

# List External Keys

GET /v1/organizations/external_keys

List external key configs in the caller's organization.

Results are ordered by creation time (newest first). Use the next_page cursor from the response to fetch subsequent pages.

# Query parameters

  • limit: optional number

    Number of results per page.

    default: 20, maximum: 100, minimum: 1

  • page: optional string

    Opaque cursor from a previous response's next_page.

# Returns

  • data: array of BetaExternalKey

    • type: "external_key"

      default: external_key

    • 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 or BetaExternalKeyUnattachedAttachment

      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.

      • BetaExternalKeyAttachedAttachment object

        • type: "attached"

          default: attached

      • BetaExternalKeyUnattachedAttachment object

        • type: "unattached"

          default: unattached

    • created_at: string

      format: date-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 or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig

      KMS provider identity and auth coordinates.

      • BetaAWSExternalKeyConfig object

        • type: "aws"

        • 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.

          maxLength: 2048

        • 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

        • type: "gcp"

        • key_name: string

          Full resource name of the Cloud KMS key.

      • BetaAzureExternalKeyConfig object

        • type: "azure"

        • key_name: string

          Name of the key within the vault.

        • tenant_id: string

          Azure AD tenant ID.

        • 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.

    • updated_at: string

      format: date-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.

# Example

bash
curl https://api.anthropic.com/v1/organizations/external_keys \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

# Response (200)

json
{
  "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"
}

# Get External Key

GET /v1/organizations/external_keys/{external_key_id}

Retrieve a single external key config in the caller's organization by ID.

# Path parameters

  • external_key_id: string

    ID of the External Key.

    maxLength: 2048

# Returns

  • BetaExternalKey object

    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).

    • type: "external_key"

      default: external_key

    • 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 or BetaExternalKeyUnattachedAttachment

      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.

      • BetaExternalKeyAttachedAttachment object

        • type: "attached"

          default: attached

      • BetaExternalKeyUnattachedAttachment object

        • type: "unattached"

          default: unattached

    • created_at: string

      format: date-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 or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig

      KMS provider identity and auth coordinates.

      • BetaAWSExternalKeyConfig object

        • type: "aws"

        • 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.

          maxLength: 2048

        • 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

        • type: "gcp"

        • key_name: string

          Full resource name of the Cloud KMS key.

      • BetaAzureExternalKeyConfig object

        • type: "azure"

        • key_name: string

          Name of the key within the vault.

        • tenant_id: string

          Azure AD tenant ID.

        • 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.

    • updated_at: string

      format: date-time

# Example

bash
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

# Response (200)

json
{
  "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"
}

# Update External Key

POST /v1/organizations/external_keys/{external_key_id}

Partially update an external key config. Omitted fields are left unchanged.

display_name is always editable. geo and provider_config cannot be changed once any workspace references this config, because previously encrypted data requires the original key identity to decrypt.

# Path parameters

  • external_key_id: string

    ID of the External Key.

    maxLength: 2048

# Body parameters

  • display_name: optional string or null

    Human-friendly display name.

    maxLength: 255, minLength: 1

  • geo: optional "us" or null

    Data residency geo. Only us is supported.

  • provider_config: optional BetaAWSExternalKeyConfig or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfigParam or null

    KMS provider identity and auth coordinates.

    • BetaAWSExternalKeyConfig object

      • type: "aws"

      • 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.

        maxLength: 2048

      • 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

      • type: "gcp"

      • key_name: string

        Full resource name of the Cloud KMS key.

    • BetaAzureExternalKeyConfigParam object

      Azure Key Vault provider configuration.

      • type: "azure"

      • key_name: string

        Name of the key within the vault.

      • tenant_id: string

        Azure AD tenant ID.

      • 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.

# Returns

  • BetaExternalKey object

    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).

    • type: "external_key"

      default: external_key

    • 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 or BetaExternalKeyUnattachedAttachment

      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.

      • BetaExternalKeyAttachedAttachment object

        • type: "attached"

          default: attached

      • BetaExternalKeyUnattachedAttachment object

        • type: "unattached"

          default: unattached

    • created_at: string

      format: date-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 or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig

      KMS provider identity and auth coordinates.

      • BetaAWSExternalKeyConfig object

        • type: "aws"

        • 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.

          maxLength: 2048

        • 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

        • type: "gcp"

        • key_name: string

          Full resource name of the Cloud KMS key.

      • BetaAzureExternalKeyConfig object

        • type: "azure"

        • key_name: string

          Name of the key within the vault.

        • tenant_id: string

          Azure AD tenant ID.

        • 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.

    • updated_at: string

      format: date-time

# Example

bash
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
    -H 'Content-Type: application/json' \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY" \
    -d '{}'

# Response (200)

json
{
  "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"
}

# Delete External Key

DELETE /v1/organizations/external_keys/{external_key_id}

Delete an external key config.

The request is rejected if any workspace still references this config.

# Path parameters

  • external_key_id: string

    ID of the External Key.

    maxLength: 2048

# Returns

  • type: "external_key_deleted"

    default: external_key_deleted

  • id: string

    ID of the deleted External Key.

# Example

bash
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID \
    -X DELETE \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

# Response (200)

json
{
  "id": "ekey_01AbCdEfGhIjKlMnOpQrStUv",
  "type": "external_key_deleted"
}

# Validate External Key

POST /v1/organizations/external_keys/{external_key_id}/validate

Validate an external key config against the customer's KMS.

Anthropic performs an encrypt/decrypt roundtrip against the configured KMS key and waits up to 30 seconds for the result. The response status is success if the roundtrip succeeded, or failure with an error message if it failed or timed out.

# Path parameters

  • external_key_id: string

    ID of the External Key.

    maxLength: 2048

# Returns

  • type: "external_key_validation"

    default: external_key_validation

  • error: string or null

    Error message when status is failure. Null otherwise.

  • status: "failure" or "success"

    success — encrypt/decrypt roundtrip succeeded. failure — the roundtrip failed or timed out; see error.

    • "failure"

    • "success"

# Example

bash
curl https://api.anthropic.com/v1/organizations/external_keys/$EXTERNAL_KEY_ID/validate \
    -X POST \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_API_KEY"

# Response (200)

json
{
  "error": "error",
  "status": "failure",
  "type": "external_key_validation"
}

# Domain types

# Beta AWS External Key Config

  • BetaAWSExternalKeyConfig object

    • type: "aws"

    • 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.

      maxLength: 2048

    • 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.

# Beta Azure External Key Config

  • BetaAzureExternalKeyConfig object

    • type: "azure"

    • key_name: string

      Name of the key within the vault.

    • tenant_id: string

      Azure AD tenant ID.

    • 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.

# Beta Azure External Key Config Param

  • BetaAzureExternalKeyConfigParam object

    Azure Key Vault provider configuration.

    • type: "azure"

    • key_name: string

      Name of the key within the vault.

    • tenant_id: string

      Azure AD tenant ID.

    • 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.

# Beta External Key

  • BetaExternalKey object

    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).

    • type: "external_key"

      default: external_key

    • 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 or BetaExternalKeyUnattachedAttachment

      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.

      • BetaExternalKeyAttachedAttachment object

        • type: "attached"

          default: attached

      • BetaExternalKeyUnattachedAttachment object

        • type: "unattached"

          default: unattached

    • created_at: string

      format: date-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 or BetaGCPExternalKeyConfig or BetaAzureExternalKeyConfig

      KMS provider identity and auth coordinates.

      • BetaAWSExternalKeyConfig object

        • type: "aws"

        • 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.

          maxLength: 2048

        • 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

        • type: "gcp"

        • key_name: string

          Full resource name of the Cloud KMS key.

      • BetaAzureExternalKeyConfig object

        • type: "azure"

        • key_name: string

          Name of the key within the vault.

        • tenant_id: string

          Azure AD tenant ID.

        • 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.

    • updated_at: string

      format: date-time

# Beta External Key Attached Attachment

  • BetaExternalKeyAttachedAttachment object

    • type: "attached"

      default: attached

# Beta External Key Unattached Attachment

  • BetaExternalKeyUnattachedAttachment object

    • type: "unattached"

      default: unattached

# Beta GCP External Key Config

  • BetaGCPExternalKeyConfig object

    • type: "gcp"

    • key_name: string

      Full resource name of the Cloud KMS key.

# External Key Delete Response

  • ExternalKeyDeleteResponse object

    • type: "external_key_deleted"

      default: external_key_deleted

    • id: string

      ID of the deleted External Key.

# External Key Validate Response

  • ExternalKeyValidateResponse object

    Result of a validation roundtrip against the customer's KMS.

    HTTP 200 for both outcomes — the operation completed; status says whether the key works.

    • type: "external_key_validation"

      default: external_key_validation

    • error: string or null

      Error message when status is failure. Null otherwise.

    • status: "failure" or "success"

      success — encrypt/decrypt roundtrip succeeded. failure — the roundtrip failed or timed out; see error.

      • "failure"

      • "success"

Files main
Menu

Theme