앱 세부 정보 관리

조직에서 생성한 앱 목록 보기

Snyk 조직이 소유한 Snyk Apps 목록을 보려면 apps/creations 엔드포인트에 GET 요청을 보냅니다.

https://api.snyk.io/rest/orgs/{orgId}/apps/creations?version={version}

자세한 내용은 조직에서 생성한 앱 목록 가져오기 엔드포인트를 참조하십시오.

앱 세부 정보 업데이트

앱의 이름이나 설정한 리디렉션 URI 목록을 업데이트할 수 있습니다.

앱을 업데이트하려면 apps/creations{app_id} 엔드포인트에 PATCH 요청을 보냅니다.

https://api.snyk.io/rest/orgs/{orgId}/apps/creations{app_id}?version={version}

app_id 경로 매개변수는 apps/creations 엔드포인트에 대한 GET 요청 응답에 포함된 id입니다.

자세한 내용은 앱 ID를 사용하여 이름, 리디렉션 URL 및 액세스 토큰 수명과 같은 앱 생성 속성 업데이트 엔드포인트를 참조하십시오.

앱 삭제

Snyk 조직에서 앱을 삭제하려면 apps/creations{app_id} 엔드포인트에 DELETE 요청을 보냅니다.

https://api.snyk.io/rest/orgs/{orgId}/apps/creations/{app_id}?version={version}

app_id 경로 매개변수는 apps/creations 엔드포인트에 대한 GET 요청 응답에 포함된 id입니다.

자세한 내용은 앱 ID로 앱 삭제 엔드포인트를 참조하십시오.

앱을 삭제하면 앱 자격 증명이 취소되고 모든 앱 설치가 제거됩니다. 활성 사용자가 있는 경우, 해당 사용자는 더 이상 앱을 통해 Snyk에 연결할 수 없게 됩니다.

앱 client_secret 순환

앱이 생성된 후에는 client_secret을 확인할 수 없습니다. 이를 분실한 경우 client_secret을 순환(Rotate)하여 새로운 비밀번호를 받을 수 있습니다.

직접 생성한 앱에 대해 apps/creations{app_id}/secrets 엔드포인트에 POST 요청을 보내 비밀번호 관리 요청을 수행하십시오.

https://api.snyk.io/rest/orgs/{orgId}/apps/creations/{app_id}/secrets?version={version}

app_id 경로 매개변수는 apps/creations 엔드포인트에 대한 GET 요청 응답에 포함된 id입니다.

자세한 내용은 Snyk 앱의 클라이언트 시크릿 관리 엔드포인트를 참조하십시오.

설치한 클라이언트 자격 증명(Client credentials) 앱의 경우, 비대화형 Snyk 앱 설치를 위한 클라이언트 시크릿 관리 엔드포인트를 참조하십시오.

POST 요청의 본문에 따라 세 가지 작업을 수행할 수 있습니다.

• 생성: {"mode": "create"}

• 삭제: {"mode": "delete", "secret": "{clientSecret}"}

• 교체: {"mode": "replace"}

Snyk은 비밀번호를 순환할 때 다음 절차를 따를 것을 권장합니다.

1. {"mode": "create"}를 사용하여 새로운 비밀번호 생성

2. 새로 생성된 비밀번호로 서비스 업데이트

3. {"mode": "delete", "secret": "{secret}"}를 사용하여 이전 비밀번호 제거

client_secret 생성

정상적인 운영 상태에서 클라이언트 시크릿을 주기적으로 순환할 것을 권장합니다. 프로세스를 시작하려면 새로운 시크릿을 생성할 엔드포인트에 {"mode": "create"} 요청 본문을 보냅니다. 이 호출의 반환 값은 새로 생성된 시크릿이 포함된 앱 정보입니다. 새로운 시크릿과 기존 시크릿 모두 수동으로 교체하거나 삭제하기 전까지는 유효합니다. 클라이언트 시크릿을 즉시 교체할 수도 있습니다.

앱은 언제든지 최대 두 개의 활성 시크릿을 가질 수 있습니다. 이미 최대 개수의 시크릿이 활성화된 상태에서 create를 호출하려고 하면 이 엔드포인트는 실패합니다.

client_secret 교체

앱의 client_secret이 유출된 경우, {"mode": "replace"}를 사용하여 새로운 시크릿을 생성할 수 있습니다.

client_secret을 교체하면 현재 시크릿은 즉시 무효화됩니다. 앱 구성에 새로운 시크릿을 업데이트할 때까지 앱은 Snyk에 연결할 수 없습니다.

client_secret 삭제

사용하지 않는 시크릿을 정리하려면 삭제하려는 클라이언트 시크릿을 {clientSecret} 자리에 넣어 {"mode": "delete", "secret": "{clientSecret}"}로 엔드포인트를 호출하십시오. 이 작업은 시크릿을 즉시 무효화하여 더 이상 사용할 수 없게 만듭니다.

앱은 최소 하나 이상의 활성 시크릿을 가져야 하므로, 마지막 시크릿에 대해 삭제를 호출하면 실패합니다.