API 키
API 키는 SecureCodingHub 관리자 UI 외부의 모든 것이 공개 REST 및 웹훅 화면과 통신하는 방법입니다. 관리자 페이지는 키를 발급하고, 활성 및 취소된 키를 나열하며, 개별 키를 취소합니다. 각 키가 실제로 무엇을 할 수 있는지에 대한 전체 참조는 API → 인증 및 스코프에 있습니다.
위치
사이드바 → 통합 섹션 아래의 API 키, /organization/api-keys입니다.
키 생성
+ 새 키 생성를 클릭합니다. 대화 상자는 다음을 요청합니다:
- 이름 — 키 목록과 감사 로그 항목에 나타나는 짧은 레이블입니다. 설명적인 것을 사용하세요("CI/CD GitHub Actions", "BI Looker sync", "Jira ticketing").
- 스코프 — 리소스별로 그룹화된 세분화된 권한입니다. 16개의 스코프는 API → 인증 및 스코프에 문서화되어 있습니다. 통합에 필요한 것만 선택하세요.
- 만료 (선택 사항) — 키가 작동을 멈추는 날짜입니다. 개념 증명 및 공급업체 평가에 유용합니다. 수동으로 취소할 때까지 유효해야 하는 키의 경우 비워 두세요.
제출 시 대화 상자는 전체 토큰(scs_live_…)을 한 번 표시합니다. 즉시 시크릿 매니저에 복사하세요. 대화 상자를 닫은 후에는 접두사와 마지막 4자만 표시됩니다 — 서버는 SHA-256 해시만 저장하므로 SecureCodingHub 지원도 이후 전체 토큰을 검색할 수 없습니다.
키 나열 및 검사
목록 보기는 조직의 모든 활성 및 취소된 키를 표시합니다. 컬럼:
| 컬럼 | 설명 |
|---|---|
| 이름 | 생성 시 키에 부여한 레이블입니다. |
| 접두사 … 마지막 4자 | 토큰의 처음 13자와 마지막 4자입니다. 복구하지 않고 키를 인식하기에 충분합니다. |
| 스코프 | 키의 세분화된 권한입니다. 많을 때는 전체 목록을 위해 호버하세요. |
| 생성자 / 일시 | 키를 발급한 관리자와 시기입니다. |
| 마지막 사용 | 이 키에 대한 가장 최근 성공적인 API 호출의 타임스탬프입니다. 사용된 적이 없는 키는 비어 있습니다. |
| 상태 | 활성, 만료 또는 취소됨입니다. |
키 취소
키 행에서 취소를 클릭합니다. 취소는 즉시입니다 — 키를 사용하는 진행 중인 요청은 몇 초 내에 401 unauthorized을 받기 시작합니다. "일시 중지" 상태는 없으며 취소 해제 방법도 없습니다. 취소는 영구적입니다. 감사 로그는 작업자 신원과 함께 작업을 apikey.revoked으로 캡처합니다.
키가 유출된 경우 취소합니다. 다운타임 없이 키를 회전해야 하는 경우, 먼저 교체를 생성하고 새 토큰을 배포한 다음 새 키가 적어도 하나의 성공적인 마지막 사용 타임스탬프를 기록한 후에만 이전 키를 취소합니다.
키당 요청 한도
모든 키는 두 개의 슬라이딩 윈도우에 의해 관리됩니다: 분당 60회 요청 및 시간당 1,000회 요청입니다. 어느 윈도우를 초과하는 요청은 Retry-After 헤더와 함께 429 rate_limited을 반환합니다. 한도는 키당이므로, 통합당 하나의 키를 발급하는 것도 하나의 시끄러운 자동화가 다른 자동화를 굶주리게 하는 것을 방지하는 방법입니다. 전체 재시도 안내는 API → 요청 한도에 있습니다.