클라우드 환경 업데이트

클라우드 환경에 대해 다음 속성을 업데이트할 수 있습니다:

• AWS: 환경 이름 및 IAM 역할 ARN(Amazon Resource Name). 새 역할 ARN은 이전 역할 ARN과 동일한 AWS 계정 ID를 가져야 합니다. 역할 ARN 찾기를 참조하십시오.

• Google: 환경 이름 및 서비스 계정 이메일 주소. 새 서비스 계정 이메일은 이전 서비스 계정 이메일과 동일한 프로젝트 ID와 연결되어야 합니다.

• Azure: 환경 이름 및 애플리케이션 ID. 새 애플리케이션 ID는 이전 애플리케이션 ID와 동일한 구독 및 테넌트와 연결되어야 합니다.

예를 들어, Terraform 또는 CloudFormation 템플릿에서 역할 이름을 변경하고 변경 사항을 배포하는 경우 Snyk IAM 역할 ARN을 업데이트해야 합니다.

다음 방법을 사용하여 Snyk 클라우드 환경을 업데이트할 수 있습니다:

• 웹 UI

• API

웹 UI

Snyk 웹 UI를 사용하여 환경을 업데이트하려면:

1. 조직 설정(Settings) > **클라우드 환경(Cloud environments)**으로 이동합니다.

2. 작업(Actions) 열에서 업데이트하려는 환경의 점 세 개를 선택합니다.

3. **업데이트(Update)**를 선택합니다.

   

   환경을 업데이트하려면 ... 아이콘을 선택합니다.
4. 일반(General) 섹션에서 업데이트된 환경 이름, 자격 증명 또는 둘 다를 입력합니다.

   

   AWS 환경 업데이트 예시

   

   Google 환경 업데이트 예시
5. **변경 사항 저장(Save changes)**을 선택합니다.

API

Snyk API를 사용하여 환경을 업데이트하려면:

1. 환경 ID 찾기

2. 환경 업데이트를 위한 API 요청 보내기

환경 ID 찾기

먼저 업데이트하려는 클라우드 환경의 ID를 찾습니다. 다음 형식으로 /cloud/environments 엔드포인트에 요청을 보냅니다:

curl -X GET \
  'https://api.snyk.io/rest/orgs/YOUR-ORGANIZATION-ID/cloud/environments?version=2022-12-21~beta' \
  -H 'Authorization: token YOUR-API-TOKEN'

출력에서 data.id 속성을 찾습니다. 다음의 축약된 예시에서 ID는 3b7ccff9-8900-4e54-0000-1234abcd1234입니다:

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "id": "3b7ccff9-8900-4e54-0000-1234abcd1234",
    <길이 때문에 생략>
  }
}

환경 업데이트

환경을 업데이트하려면 클라우드 공급자에 대해 다음 형식으로 /cloud/environments/{environment_id} 엔드포인트에 요청을 보냅니다.

AWS

curl -X PATCH \
'https://api.snyk.io/rest/orgs/YOUR-ORGANIZATION-ID/cloud/environments/YOUR-ENVIRONMENT-ID?version=2022-12-21~beta' \
-H 'Authorization: token YOUR-API-TOKEN' \
-H "Content-Type:application/vnd.api+json"  -d '{
  "data": {
    "attributes": {
      "options": {
        "role_arn": "YOUR-NEW-ROLE-ARN"
      }
    },
    "type": "resource"
  }
}'

Google

data.attributes.options.service_account_email은 필수입니다. data.attributes.options.project_id 필드를 사용하여 프로젝트 ID를 명시적으로 지정할 수도 있지만, 현재 프로젝트 ID와 달라서는 안 됩니다.

curl -X PATCH \
'https://api.snyk.io/rest/orgs/YOUR-ORGANIZATION-ID/cloud/environments/YOUR-ENVIRONMENT-ID?version=2022-12-21~beta' \
-H 'Authorization: token YOUR-API-TOKEN' \
-H "Content-Type:application/vnd.api+json"  -d '{
  "data": {
    "attributes": {
      "options": {
        "service_account_email": "YOUR-NEW-SERVICE-ACCOUNT-EMAIL"
      }
    },
    "type": "resource"
  }
}'

Azure

data.attributes.options.tenant_id 및 data.attributes.options.subscription_id는 필수이며 현재 값과 달라서는 안 됩니다.

curl -X PATCH \
'https://api.snyk.io/rest/orgs/YOUR-ORGANIZATION-ID/cloud/environments/YOUR-ENVIRONMENT-ID?version=2022-12-21~beta' \
-H 'Authorization: token YOUR-API-TOKEN' \
-H 'Content-Type:application/vnd.api+json' -d '{
  "data": {
    "attributes": {
      "name": "YOUR-NEW-ENVIRONMENT-NAME",
      "options": {
        "application_id": "YOUR-NEW-APPLICATION-ID",
        "tenant_id": "00000000-0000-0000-1234-12345678abcd",
        "subscription_id": "abcd1234-abcd-1234-0000-000000000000"
      }
    },
    "type": "resource"
  }
}'

API 응답 이해

Snyk은 업데이트된 환경 세부 정보가 포함된 JSON 문서를 반환합니다. 예를 들어, AWS 환경을 보여주는 다음 응답:

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "id": "3b7ccff9-8900-4e54-0000-1234abcd1234",
    "type": "environment",
    "attributes": {
      "name": "Example AWS Environment",
      "options": {
        "role_arn": "arn:aws:iam::123412341234:role/snyk-cloud-role-updated"
      },
      "native_id": "123412341234",
      "properties": {
        "account_id": "123412341234"
      },
      "kind": "aws",
      "revision": 2,
      "created_at": "2022-07-31T00:50:49Z",
      "status": "success",
      "updated_at": "2022-08-17T18:18:01Z"
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "d70c1768-5675-0000-1234-abcd1234abcd",
          "type": "organization"
        },
        "links": {
          "related": "/orgs/d70c1768-5675-0000-1234-abcd1234abcd?version=2022-12-21~beta"
        }
      }
    }
  }
}

JSON 출력의 data.attributes.options 및 data.attributes.properties 필드는 클라우드 공급자에 따라 다르며 업데이트된 정보를 보여줍니다.