API 키 조회 (Admin API)

beta.organization.api_keys.retrieve(api_key_id) -> BetaAPIKey

GET/v1/organizations/api_keys/{api_key_id}

조직 내 단일 API 키에 대한 정보를 ID로 조회합니다. 이 Admin API 엔드포인트는 Admin API 키가 필요하고, 프로그래밍 방식의 키 관리를 위한 것이며, 키의 비밀 값은 절대 반환하지 않습니다. 자신의 API 키를 보거나 생성하려면 Claude Console의 API 키로 이동하세요.

Parameters

api_key_id: String⁠Path

ID of the API key.

Returns

class BetaAPIKey { type: :api_key, id, created_at, 8 more }

API 키 조회 (Admin API)

require "anthropic"

anthropic = Anthropic::Client.new(api_key: "my-anthropic-api-key")

beta_api_key = anthropic.beta.organization.api_keys.retrieve("api_key_id")

puts(beta_api_key)

Response 200

{
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
    "type": "user"
  },
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "name": "Developer Key",
  "partial_key_hint": "sk-ant-api03-R2D...igAA",
  "principal": {
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "scope": {
    "type": "workspace",
    "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
  },
  "status": "active",
  "type": "api_key",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}

Returns Examples

Response 200

{
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
    "type": "user"
  },
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "name": "Developer Key",
  "partial_key_hint": "sk-ant-api03-R2D...igAA",
  "principal": {
    "type": "user_actor",
    "user_id": "user_01WCz1FkmYMm4gnmykNKUu3Q"
  },
  "scope": {
    "type": "workspace",
    "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
  },
  "status": "active",
  "type": "api_key",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}