Snyk API 사용 시나리오

Snyk API 시나리오는 API를 사용하여 Snyk 애플리케이션에서 작업을 완수하기 위해 사용할 수 있는 절차를 식별합니다. 이 페이지에 나열된 시나리오들은 Snyk 프로세스별로 그룹화되어 있으며 리포지토리 또는 사용자 문서 사이트에서 제공됩니다. 링크가 포함되어 있습니다.

이러한 절차를 사용할 때 문제가 발생하는 경우 기술 성공 관리자(Technical Success Manager) 또는 솔루션 엔지니어(Solutions Engineer)에게 문의하거나 Snyk 지원팀에 티켓을 제출하십시오.

Snyk 조직 구조 관리

지정된 그룹 내에서 모두 동일한 설정을 가진 여러 개의 새로운 조직 생성

시나리오: create-multiple-orgs-and-copy-settings (전체 절차)

사용된 엔드포인트: 새 조직 생성 조직 설정 보기 조직 설정 업데이트 설정 및 자격 증명을 포함한 통합 복제

지정된 목록의 모든 사용자를 회사의 모든 조직(그룹 내 모든 조직)에 할당

시나리오: assign-users-to-all-orgs (전체 절차)

사용된 엔드포인트: 그룹의 모든 멤버 목록 보기 사용자 초대

첫 로그인 전에 대규모로 조직에 사용자 추가

시나리오: API를 통해 조직에 사용자 프로비저닝

사용된 엔드포인트: 조직에 사용자 프로비저닝

Snyk 프로젝트 가져오기 및 설정

새로운 리포지토리만 식별하고 가져오기

시나리오: Identify-and-import-new-repos (전체 절차)

사용된 엔드포인트: 조직 ID로 대상 가져오기 대상 가져오기

새로운 컨테이너 이미지 가져오기

시나리오: import-new-container-images (전체 절차)

사용된 엔드포인트: 지정된 조직 ID를 가진 조직의 모든 프로젝트 목록 보기 대상 가져오기 가져오기 작업 세부 정보 가져오기 프로젝트 삭제

정기적으로 리포지토리의 새로운 프로젝트(파일)를 감지하여 Snyk의 대상으로 가져오기

시나리오: Identify-and-import-new-repos (전체 절차)

사용된 엔드포인트: 조직 ID로 대상 가져오기 대상 가져오기

Snyk 프로젝트 관리

Snyk의 모든 프로젝트에 태그 달기

시나리오: Tag projects in Snyk (전체 절차)

사용된 엔드포인트: 지정된 조직 ID를 가진 조직의 모든 프로젝트 목록 보기

프로젝트를 한 조직에서 다른 조직으로 이동

시나리오: Move projects between organizations (전체 절차)

사용된 API 토큰에는 그룹 관리자(Group Admin) 권한이 있어야 합니다. 서로 다른 그룹에 속한 조직 간에 이동하는 경우, 두 그룹 모두에서 그룹 관리자 권한이 있는 개인 API 토큰을 사용해야 합니다. 서비스 계정은 서로 다른 그룹에 속한 조직 간에 프로젝트를 이동할 수 없습니다.

보고를 위한 과거 데이터는 손실됩니다.

사용된 엔드포인트: 프로젝트를 다른 조직으로 이동

SCM과 통합

어떤 이유로든 Broker 토큰을 순환하거나 변경

시나리오: Broker-token-rotation (전체 절차)

사용된 엔드포인트: 사용자가 속한 모든 조직 목록 보기 (그룹 관리자 전용) 새로운 통합 추가 기존 통합 업데이트 (Broker 활성화용)

특정 이벤트 또는 시간 동안 Snyk에서 코드 베이스(소스 제어 관리 리포지토리)로의 모든 상호 작용(풀 리퀘스트, 테스트) 비활성화

시나리오: disable-all-interaction-from-snyk (전체 절차)

사용된 엔드포인트 대안 1: 서로 다른 조직에서 통합 정보를 가져온 다음 각 통합 설정을 업데이트 목록 보기 (통합) 업데이트 (통합 설정) 기존 통합 업데이트

사용된 엔드포인트 대안 2: 웹훅 접근 방식: 웹훅 ID를 가져와서 웹훅을 삭제하여 Snyk 웹훅 제거 웹훅 목록 보기 웹훅 삭제 웹훅 생성

문제 검색 및 관리

지정된 그룹의 모든 프로젝트에 대해 프로젝트 스냅샷 검색

시나리오: Retrieve-project-snapshots (전체 절차)

사용된 엔드포인트: 그룹의 모든 조직 목록 보기 최신 문제 목록 가져오기

취약점의 영향을 받는 모든 프로젝트 찾기

시나리오: find-all-projects-affected-by-a-vuln.md (전체 절차)

사용된 엔드포인트: 문제 목록 가져오기 그룹의 모든 조직 목록 보기 지정된 조직 ID를 가진 조직의 모든 프로젝트 목록 보기

대량 문제 무시

시나리오: bulk-ignore-issues (전체 절차)

사용된 엔드포인트: 지정된 조직 ID를 가진 조직의 모든 프로젝트 목록 보기 최신 문제 목록 가져오기 (Code를 제외한 모든 문제를 가져오기 위함) 조직 ID로 문제 가져오기 (모든 Code 문제를 가져오기 위함)

조직의 모든 프로젝트에서 Snyk Code 문제를 포함한 모든 문제 목록 보기

시나리오: list-all-issues-for-a-snyk-org (전체 절차)

사용된 엔드포인트: 지정된 조직 ID를 가진 조직의 모든 프로젝트 목록 보기 모든 집계된 문제 목록 보기 (Code 제외) 조직 ID로 문제 가져오기 2025년 4월부터 이 엔드포인트를 사용하여 Snyk Code 문제를 검색할 수 있습니다. 문제의 coordinates 내 representations에 있는 source_location 데이터에 기본 파일 경로와 기본 영역 정보가 포함됩니다. REST 실험적 ID로 Snyk Code 문제 가져오기 무시 검색