메인 콘텐츠로 건너뛰기
API 키는 Guard API 호출을 인가합니다. API 키는 API 프로젝트 내의 Guardian에 속합니다.

​
키 생성

Guardian → API Keys → Add API Key를 열고 이름을 지정한 다음 Create를 선택합니다.
Add API Key 버튼이 강조 표시된 API Keys 페이지
키는 확인 대화 상자에 한 번만 표시되며 sf_로 시작합니다. 나중에 다시 조회할 수 없으므로 지금 복사하세요.
키를 지금 복사하세요 — 한 번만 표시됩니다
키는 비밀번호처럼 다루세요. 키의 이름은 모든 trace에 태그로 표시되므로, 호출자나 환경에 따라 키 이름을 지정하세요(예: prod-backend). 키 이름은 프로젝트 내에서(모든 Guardian의 키를 통틀어) 고유해야 하므로, 이름이 트레이스에서 호출자를 명확하게 식별합니다.

​
키 수명 주기

상태의미전환
Active정상적으로 작동합니다.→ Inactive, → Revoked
Inactive관리자가 일시적으로 비활성화함 — 호출이 거부됩니다.→ Active, → Revoked
Revoked영구적으로 비활성화됨.없음 — 되돌릴 수 없음
Active와 Inactive는 자유롭게 전환됩니다. Revoke는 영구적입니다: 취소된 키는 다시 활성화할 수 없으므로 — 대신 새 키를 발급하세요. 키가 없거나 유효하지 않거나 취소된 호출은 HTTP 401을 받습니다 — 인증 및 오류 및 상태를 참고하세요.

​
키 상태 vs. Kill Switch

키의 상태와 Kill Switch는 독립적이며, Starfort는 모든 요청마다 둘 다 확인합니다:
  • Kill Switch(조직, 프로젝트, 또는 Guardian에 적용)는 켜져 있는 동안 Active 키에 대해서도 트래픽을 차단합니다. 키는 상태를 그대로 유지하며 스위치가 해제되는 즉시 정상적으로 재개됩니다.
  • Guardian 위에 어떤 Kill Switch라도 켜져 있는 동안에는 그곳에서 새 키를 생성할 수도 없습니다.