---
title: List External Keys
url: https://platform.claude.com/docs/en/api/java/organization/external_keys/list
---

# List External Keys

`ExternalKeyListPage organization().externalKeys().list(params = ExternalKeyListParams.none(), requestOptions = RequestOptions.none())`

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

## Parameters

- `ExternalKeyListParams params`

  - `Optional<Long> limit` (query parameter)

    Number of results per page.

    minimum: 1, maximum: 100

  - `Optional<String> page` (query parameter)

    Opaque cursor from a previous response's `next_page`.

## Returns

- `class ExternalKey`

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

  - `JsonValue type = "external_key"`

  - `String id`

    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 attachment`

    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.

    - `class ExternalKeyAttachedAttachment`

      - `JsonValue type = "attached"`

    - `class ExternalKeyUnattachedAttachment`

      - `JsonValue type = "unattached"`

  - `LocalDateTime createdAt`

    format: date-time

  - `Optional<String> displayName`

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

  - `String geo`

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

  - `ProviderConfig providerConfig`

    KMS provider identity and auth coordinates.

    - `class AwsExternalKeyConfig`

      - `JsonValue type = "aws"`

      - `String kmsArn`

        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

      - `Optional<String> region`

        AWS region. Derived from `kms_arn` if omitted.

    - `class GcpExternalKeyConfig`

      - `JsonValue type = "gcp"`

      - `String keyName`

        Full resource name of the Cloud KMS key.

    - `class AzureExternalKeyConfig`

      - `JsonValue type = "azure"`

      - `String keyName`

        Name of the key within the vault.

      - `String tenantId`

        Azure AD tenant ID.

      - `String vaultUri`

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

      - `Optional<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.

  - `LocalDateTime updatedAt`

    format: date-time

## Example

```java
package com.anthropic.example;

import com.anthropic.client.AnthropicClient;
import com.anthropic.client.okhttp.AnthropicOkHttpClient;
import com.anthropic.models.organization.externalkeys.ExternalKeyListPage;
import com.anthropic.models.organization.externalkeys.ExternalKeyListParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        AnthropicClient client = AnthropicOkHttpClient.fromEnv();

        ExternalKeyListPage page = client.organization().externalKeys().list();
    }
}
```

### 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"
}
```