Skip to main content
API 키는 사용자 또는 서비스 계정을 W&B에 인증합니다. 이 페이지에서는 W&B에서 발급하는 API 키의 유형, 키를 찾고 관리하는 위치, 그리고 구성원의 키 생성 및 사용을 제한하는 조직 설정을 설명합니다. 자격 증명을 관리하는 조직 관리자와 팀 관리자, 그리고 자신의 키를 관리하는 구성원을 위한 문서입니다. API 키를 받은 후 안전하게 저장하는 방법은 API 키를 안전하게 저장 및 처리를 참조하세요.

​
API 키 유형

W&B는 사용자와 서비스 계정 모두에게 API 키를 발급합니다.

​
API 키 찾기 및 관리

조직 관리자, 팀 관리자 및 구성원은 API Keys 탭에서 키를 관리할 수 있습니다.
  1. 오른쪽 상단의 프로필 아이콘을 클릭한 다음 조직을 선택합니다.
  2. https://wandb.ai/account-settings/[ORGANIZATION]/api-keys로 이동합니다. [ORGANIZATION]을 조직 이름으로 바꿉니다. API Keys 탭에는 볼 권한이 있는 키가 표시됩니다.
본인의 개인 API 키만 찾으려면 프로필 아이콘을 클릭한 다음 사용자 설정를 클릭하고 API Keys 섹션까지 스크롤합니다. 사용자 설정을 참조하세요.
Multi-tenant Cloud에서 조직 역할이 청구 관리자인 사용자는 API Keys 탭을 볼 수 없습니다. Dedicated Cloud 및 Self-Managed에서는 청구 역할에 따라 이 탭이 제한되지 않습니다.

​
역할별 키 가시성

API Keys 탭에 표시되는 키는 역할에 따라 다릅니다.

​
API 키 테이블 확인

테이블에는 각 키에 대해 다음 열이 표시됩니다.
  • 키 이름: 키를 생성할 때 지정한 설명 이름입니다.
  • 키 ID: 식별에 사용되는 키의 첫 부분입니다.
  • 소유자: 키를 소유한 사용자 또는 서비스 계정입니다.
  • 마지막 사용: 키가 가장 최근에 요청을 인증한 시점입니다.
  • 생성일: 키가 생성된 시점입니다.
보안을 위해 테이블에는 키 ID만 표시됩니다. W&B는 키를 생성할 때 전체 시크릿 키를 한 번만 표시합니다. 키의 전체 시크릿을 더 이상 보유하고 있지 않은 경우 키를 교체하세요.
목록 범위를 좁히려면 검색 필드에 키 이름, 키 ID 또는 소유자를 입력하거나 Filters를 클릭하여 키 유형과 같은 속성으로 필터링하세요.

​
API 키 만들기

  1. API Keys 탭으로 이동합니다.
  2. New key를 클릭합니다.
  3. 키를 쉽게 식별할 수 있는 이름을 지정합니다.
  4. Create를 클릭합니다.
  5. 키를 즉시 복사하여 안전하게 보관합니다.
W&B는 전체 API 키를 생성 시점에 한 번만 표시합니다. 대화 상자를 닫으면 전체 API 키를 다시 볼 수 없습니다. Settings에서는 키 ID(키의 첫 부분)만 확인할 수 있습니다. 전체 API 키를 분실한 경우 새 API 키를 만들어야 합니다.
Multi-tenant Cloud에서 이 탭을 통해 생성한 키는 현재 보고 있는 조직에 속합니다. 작업하는 조직마다 별도의 키를 생성하세요.

​
API 키 이름 변경

키의 사용처를 기록할 수 있도록 이름을 변경하세요. 그러면 나중에 낯선 키도 더 쉽게 확인할 수 있습니다. 이름을 변경해도 키의 시크릿은 바뀌지 않으며, 해당 키를 사용하는 항목이 중단되지 않습니다.
  1. 테이블에서 키를 찾습니다.
  2. 키 행 끝에 있는 작업 메뉴를 클릭한 다음 Edit를 클릭합니다.
  3. 새 이름을 입력한 다음 저장합니다.

​
API 키 삭제

더 이상 필요하지 않은 키는 삭제하세요. 키가 노출되었을 가능성이 있다면 즉시 삭제하세요. 키 하나를 삭제하려면 테이블에서 해당 키를 찾고 해당 행 끝의 작업 메뉴를 클릭한 다음 Delete를 클릭하고 확인하세요. 여러 키를 한 번에 삭제하려면 다음 단계를 따르세요.
  1. 삭제할 각 키 옆의 확인란을 선택합니다.
  2. Delete를 클릭합니다. 버튼에 선택한 키 수가 표시됩니다.
  3. 삭제를 확인합니다.
키를 삭제하면 해당 키를 사용하는 모든 스크립트나 서비스의 액세스가 즉시 취소됩니다. 이전 키를 삭제하기 전에 시스템이 대체 키를 사용하도록 업데이트하세요.

​
API 키 교체

보안 정책에 맞는 주기로 키를 교체하고, 키가 노출되었을 가능성이 있으면 즉시 교체하세요. 키를 사용하는 워크로드를 계속 실행해야 하는 경우에는 삭제하지 말고 키를 교체하세요. W&B에는 단일 키 교체 액션이 없습니다. 키의 전체 시크릿은 생성 시에만 표시되므로, 다음과 같이 키를 교체합니다.
  1. 새 API 키를 만드세요. 교체할 키와 구분되는 이름을 지정하세요.
  2. 이전 키를 사용하는 모든 스크립트, 작업 및 저장된 시크릿을 업데이트하세요. 저장 옵션은 API 키를 안전하게 저장하고 처리하기를 참조하세요.
  3. 워크로드가 새 키로 인증되는지 확인하세요.
  4. 이전 키를 삭제하세요.
마지막 단계를 완료하기 전까지는 두 키가 모두 작동합니다. 이 중복 기간 덕분에 중단 없이 키를 교체할 수 있으므로, 가능한 한 짧게 유지하세요.
키가 공개적으로 노출된 경우, 시스템을 업데이트할 때까지 기다리지 말고 즉시 삭제하세요. 노출된 키는 삭제할 때까지 유효합니다.

​
구성원의 API 키 사용 제한

조직 관리자는 W&B App의 조직 설정에서 API 키 생성 및 사용을 제한할 수 있습니다. 이러한 제한을 통해 조직의 리소스에 접근할 수 있는 키와 새 키를 생성할 수 있는 사용자를 한정할 수 있습니다. 다음 섹션에서는 적용할 수 있는 제한 사항을 설명하며, 이는 배포 유형에 따라 다릅니다.

​
조직 범위 API 키 강제 적용

Enterprise 조직의 Multi-tenant Cloud 에서 사용할 수 있습니다. 이 설정은 W&B가 조직별로 활성화합니다. 설정이 보이지 않으면 W&B 계정 팀에 문의하세요. 강제 적용하면 조직 API 키와 해당 조직의 서비스 계정에 속한 키만 조직의 리소스에 액세스할 수 있습니다. 구성원이 여러 조직에서 사용하던 개인 API 키는 더 이상 이 조직에서 동작하지 않으므로, 다른 곳에서 유출된 키가 데이터에 접근하는 것을 방지할 수 있습니다.
이 설정을 강제 적용하는 즉시 개인 API 키는 해당 조직에 대한 조회 및 쓰기 액세스 권한을 잃으며, personal key를 사용하는 인테그레이션은 모두 동작을 멈춥니다. 강제 적용하기 전에 Users에게 미리 알리세요.
조직 범위 API 키를 강제 적용하려면 다음 step을 수행하세요.
  1. 조직 관리자로 로그인합니다.
  2. 조직 설정을 열고 왼쪽 내비게이션에서 Authentication 을 선택합니다.
  3. Enforce organization-scoped API keys 옆의 Enforce 를 클릭합니다.
  4. 조직 name을 입력해 확인한 후 Enforce Organization-Scoped API Keys 를 클릭합니다.
그러면 W&B가 해당 설정 옆에 Enforced 라벨을 표시합니다. 강제 적용을 중단하려면 Authentication 으로 돌아가 Disable 을 클릭하세요.

​
API 키 생성 비활성화

Dedicated Cloud 및 Self-Managed v0.84.0 이상에서 사용할 수 있습니다. 이 설정을 켜면 사용자와 팀 서비스 계정은 새 API 키를 생성할 수 없습니다. 조직 서비스 계정는 계속 키를 생성할 수 있고 기존 키도 그대로 동작하므로, 이 설정을 켜도 실행 중인 작업이 중단되지 않습니다. 조직에서 통제된 절차를 통해 키를 발급하고 있고 구성원이 직접 키를 만드는 것을 막으려는 경우에 사용하세요. API 키 생성을 비활성화하려면 다음 step을 따르세요.
  1. 조직 관리자로 로그인합니다.
  2. 조직 대시보드를 열고 왼쪽 내비게이션에서 Privacy를 선택합니다.
  3. Access Control 섹션에서 Disable API key creation을 켭니다.
W&B는 변경 사항을 즉시 저장합니다. 이 탭의 다른 설정은 개인정보 보호 설정 구성을 참조하세요. 이 설정이 켜져 있는 동안에는 API Keys 탭의 New key 버튼이 비활성화되고 다음 메시지가 표시됩니다.
서비스 계정 생성까지 제한하려면 GORILLA_DISABLE_TEAM_SERVICE_ACCOUNT_CREATION을 참조하세요. 이 환경 변수는 Dedicated Cloud 및 Self-Managed v0.83.0 이상에서 새로운 팀 범위 서비스 계정이 생성되지 않도록 차단합니다.

​
사용 가능 여부

API 키 기능은 배포 유형에 따라 다르며, Multi-tenant Cloud에서는 구독 유형에 따라서도 다릅니다. 다음 표에서는 각 기능의 사용 가능 여부를 요약합니다.

​
API 키를 안전하게 저장하고 관리하기

API 키는 W&B 계정에 접근할 수 있게 하므로 비밀번호처럼 보호해야 합니다. 다음 섹션에서는 권장 저장 방법, 피해야 할 관행, 코드에 키를 전달하는 방법, 그리고 최신 키에 필요한 SDK 버전 요구 사항을 설명합니다. 다음 방법 중 하나를 사용하여 API 키를 안전하게 저장하세요.
  • Secrets manager: AWS Secrets Manager, HashiCorp Vault, Azure Key Vault, 또는 Google Secret Manager와 같은 전용 시크릿 관리 시스템을 사용하세요.
  • Password manager: 신뢰할 수 있는 비밀번호 관리 애플리케이션을 사용하세요.
  • OS-level keychains: macOS Keychain, Windows Credential Manager, 또는 Linux secret service에 키를 저장하세요. 프로덕션 환경에는 권장되지 않습니다.

​
피해야 할 사항

다음과 같은 관행은 API 키를 노출시킬 수 있으므로 피하세요.
  • Git과 같은 버전 관리 시스템에 API 키를 절대 커밋하지 마세요.
  • API 키를 평문 설정 파일에 저장하지 마세요.
  • ps와 같은 OS 명령의 출력에 표시되므로, 명령줄 인수로 API 키를 전달하지 마세요.
  • 이메일, 채팅 또는 기타 암호화되지 않은 채널을 통해 API 키를 공유하지 마세요.
  • 소스 코드에 API 키를 하드코딩하지 마세요.
API 키가 노출된 경우, W&B 계정에서 즉시 해당 API 키를 삭제하고 지원팀 또는 AISE에 문의하세요.

​
환경 변수

코드에서 API 키를 사용할 때는 환경 변수를 통해 전달하세요:
이 방식은 키를 소스 코드에 넣지 않도록 하고, 필요할 때 더 쉽게 교체할 수 있게 해줍니다.
ps 같은 OS 명령어의 출력에 표시되므로, 환경 변수를 명령어와 같은 줄에서 설정하지 마세요:

​
SDK 버전 호환성

최신 API 키를 사용하는 경우, SDK 버전이 이를 지원하는지 확인하세요. 새 API 키는 기존 키보다 더 깁니다. 이전 버전의 wandb 또는 weave SDK로 인증할 때 API 키 길이 오류가 발생할 수 있습니다. 해결 방법: 최신 SDK 버전으로 업데이트하세요.
  • wandb SDK v0.22.3+
  • weave SDK v0.52.17+
SDK를 바로 업그레이드할 수 없다면, 우회 방법으로 WANDB_API_KEY 환경 변수를 사용해 API 키를 설정하세요.