자격 증명 순환 웹후크 구현

엔드포인트 요구 사항

다음 구조를 사용하여 엔드포인트를 노출합니다.

PUT https://<your-registered-base-url>/v1/organizations/{organizationId}/projects/{projectId}/secrets

온보딩 중에 Atlas에 기본 URL을 등록합니다. organizationId 및 projectId 경로 매개변수는 통합과 관련된 Atlas 조직 및 프로젝트를 식별합니다. 온보딩 과정에서 Atlas와 합의한 경우 다른 URL 구조를 사용할 수 있지만, 등록된 기본 URL과 필수 식별자는 명확하게 유지되어야 합니다.

Atlas는 프로비저닝 중에 설정된 설치 범위의 Bearer token으로 각 요청을 인증합니다.

Authorization: Bearer <installation-access-token>Content-Type: application/json

엔드포인트는 다음 조건을 충족해야 합니다.

• 모든 요청에서 Bearer token을 검증하고, 유효하지 않거나 만료된 토큰은 401 Unauthorized으로 거부하세요.

• 토큰을 기밀로 취급하고 적절한 액세스 제어를 사용하여 저장하세요.

• 신뢰할 수 있는 인증 기관의 TLS 인증서와 함께 HTTPS를 사용하세요. Atlas는 일반 HTTP를 통해 엔드포인트를 호출하지 않으며, 프로덕션 환경에서는 자체 서명된 인증서가 지원되지 않습니다.

요청 본문

요청 본문에는 업데이트할 자격 증명 키-값 쌍이 포함되어 있습니다.

{  "secrets": [    {      "name": "ATLAS_CONNECTION_STRING",      "value": "mongodb+srv://user:pass@cluster.mongodb.net/"    },    {      "name": "ATLAS_DB_USERNAME",      "value": "app_user"    },    {      "name": "ATLAS_DB_PASSWORD",      "value": "rotated_password"    }  ],  "partial": true}

응답

재시도 및 멱등성

Atlas는 지수 백오프와 제한된 재시도 횟수를 사용하여 실패한 요청(5xx 응답 또는 네트워크 시간 초과)을 재시도합니다.

엔드포인트는 멱등성이 있어야 합니다. 동일한 로테이션 이벤트에 대해 중복 요청을 받을 수 있습니다. 그리고 동일한 자격 증명 값을 한 번 이상 적용하는 것은 오류 없이 동일한 결과를 생성해야 합니다.

보안 요구 사항

위의 인증 요구 사항 외에도 엔드포인트는 다음을 충족해야 합니다.

• 저장된 자격 증명을 암호화합니다.

• 애플리케이션 로그, 요청 로그, 오류 메시지, 원격 분석 또는 일반 텍스트 설정 파일에 자격 증명 값이 나타나지 않도록 하십시오.

• 저장된 자격 증명에 대한 액세스를 필요한 시스템 및 담당자로 제한합니다.

• 10 초 이내에 응답합니다. 새 자격 증명을 유지하는 데 배경 처리가 필요한 경우 요청을 동기식으로 승인하고 처리를 비동기식으로 완료합니다.

• 설치 액세스 토큰이 유출되었다고 의심되는 경우 합의된 Atlas 지원 프로세스를 따르십시오.

온보딩 체크리스트

Atlas가 교체된 자격 증명을 통합으로 보내려면 먼저 다음을 수행해야 합니다.

• 온보딩 중에 콜백 기본 URL을 등록하세요.

• 설치 액세스 토큰을 설정하고 양측 모두에서 안전하게 저장합니다.

• 자격 증명 이름과 업데이트 의미 체계에 동의하고 문서화합니다.

• HTTPS를 통해 액세스할 수 있도록 엔드포인트를 배포하세요.

• 엔드포인트가 예상되는 상태 코드를 반환하는지 확인하세요.

• 비운영 환경의 비운영 설치에서 종단간(end-to-end) 교체를 수동으로 테스트합니다.

• 중복 전달 및 재시도 동작 테스트.

추가 리소스

• Atlas 앱 Connections와 앱 통합

• 데이터베이스 사용자 수명 주기