/ /

/ /

키 볼트 구성 하나 업데이트

하나의 키 볼트 구성을 업데이트합니다. MongoDB Ops Manager는 전송한 필드를 저장된 구성과 병합하고 생략한 필드는 그대로 두업니다.

필수 역할

이 엔드포인트를 호출하는 API 키에 Global Owner 역할이 있어야 합니다.

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin

Resource

PATCH /keyVault/{KEY-VAULT-ID}

요청 경로 매개변수

이름	유형	설명
KEY-VAULT-ID	문자열	업데이트할 키 보조소 구성의 고유 식별자입니다.

요청 쿼리 매개변수

다음 쿼리 매개변수는 선택 사항입니다.

이름	유형	필요성	설명	기본값
pretty	부울	옵션	응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다.	`false`
envelope	부울	옵션	응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다. `status`HTTP 응답 코드 `content`예상되는 응답 본문	`false`

요청 본문 매개변수

이름	유형	필요성	설명
friendlyName	문자열	옵션	이 키 보관소 구성을 식별하는 인간 가독형 레이블입니다. MongoDB Ops Manager는 Key Vault 목록과 Vault Name 필드에서 이 값을 표시합니다.
유형	문자열	옵션	키 보고소 제공자 유형. MongoDB Ops Manager는 HashiCorp Vault를 나타내는 `HASHI_CORP`만 허용합니다.
URL	문자열	옵션	MongoDB Ops Manager가 연결하는 HashiCorp Vault 서버의 주소(예: `https://localhost:8200/`)
인증	객체	옵션	MongoDB Ops Manager가 HashiCorp Vault에 연결하는 데 사용되는 인증 세부 정보
auth.mechanism	문자열	조건부	MongoDB Ops Manager HashiCorp Vault 연결하는 데 사용하는 인증 방법입니다. `auth` 객체를 업데이트할 때 필요합니다. MongoDB Ops Manager는 다음 값을 허용합니다. `TOKEN` `JWT`
auth.secret	문자열	옵션	MongoDB Ops Manager가 HashiCorp Vault에 대한 인증에 사용하는 자격 증명입니다. `auth.mechanism` 이 `TOKEN`인 경우, 이 값을 Vault 토큰으로 설정합니다. `auth.mechanism` 가 인 `JWT` 경우, 이 값을 JWT에 서명하는 PEM 형식의 RSA 개인 키로 설정합니다. 저장된 자격 증명을 유지하려면 이 필드를 생략하거나 MongoDB Ops Manager가 반환하는 수정된 값을 보냅니다. MongoDB Ops Manager는 이 값을 유휴 시 암호화하고 API 응답에서 수정합니다.
auth.jwtClaims	객체	조건부	HashiCorp Vault에 JSON web token 로그인을 요청할 때 MongoDB Ops Manager가 보내는 주장입니다. `auth.mechanism` 가 `JWT`인 경우 필수입니다. `user` 및 `role` 필드를 포함합니다.
customCertificates	배열	옵션	MongoDB Ops Manager가 HashiCorp Vault 서버에 연결할 때 TLS 확인에 사용하는 사용자 지정 인증서 목록.
customCertificates[n].filename	문자열	조건부	인증 기관 PEM 파일을 식별하는 이름입니다. `customCertificates`의 각 항목에 필요합니다.
customCertificates[n].certString	문자열	조건부	인증 기관 PEM 파일의 내용입니다. `customCertificates`의 각 항목에 필요합니다. 저장된 인증서를 유지하려면 Ops Manager가 반환하는 수정된 값을 전송합니다. Ops Manager는 API 응답에서 이 값을 수정합니다.

응답

이름	유형	설명
id	문자열	MongoDB Ops Manager가 이 키 보관소 구성에 대해 생성하는 고유 식별자입니다. 이 키 보관소를 사용하도록 S3호환 저장 스냅샷 저장소를 구성할 때 이 값을 `vaultId` 으로 사용합니다.
friendlyName	문자열	이 키 보관 구성을 식별하는 인간 가독형 레이블입니다.
유형	문자열	키 보고소 제공자 유형. MongoDB Ops Manager는 HashiCorp Vault를 나타내는 `HASHI_CORP`을 반환합니다.
URL	문자열	MongoDB Ops Manager가 연결하는 HashiCorp Vault 서버의 주소입니다.
인증	객체	MongoDB Ops Manager가 HashiCorp Vault에 연결하는 데 사용되는 인증 세부 정보
auth.mechanism	문자열	MongoDB Ops Manager HashiCorp Vault 연결하는 데 사용하는 인증 방법입니다. MongoDB Ops Manager는 다음 값 중 하나를 반환합니다. `TOKEN` `JWT`
auth.secret	문자열	MongoDB Ops Manager가 HashiCorp Vault에 인증하는 데 사용하는 자격 증명입니다. MongoDB Ops Manager는 이 값을 유휴 시 암호화하고 저장된 값 대신 `[REDACTED]` 을 반환합니다.
auth.jwtClaims	객체	HashiCorp Vault에 JSON web token 로그인을 요청할 때 MongoDB Ops Manager가 보내는 주장입니다. MongoDB Ops Manager는 `auth.mechanism` 가 `JWT`일 경우에만 이 객체를 반환합니다.
customCertificates	배열	MongoDB Ops Manager가 HashiCorp Vault 서버에 연결할 때 TLS 확인에 사용하는 사용자 지정 인증서 목록.
customCertificates[n].filename	문자열	인증 기관 PEM 파일을 식별하는 이름입니다.
customCertificates[n].certString	문자열	인증 기관 PEM 파일의 내용입니다. MongoDB Ops Manager는 저장된 값 대신 `[REDACTED]` 를 반환합니다.
링크	객체 배열	하위 리소스 또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에 설명되어 있습니다.

요청 예시

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request PATCH 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault/{KEY-VAULT-ID}?pretty=true' \
     --data '{
       "url": "https://vault.example.com:8200/"
     }'

응답 예시

응답 헤더

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

응답 본문

{
  "id": "{KEY-VAULT-ID}",
  "friendlyName": "myVault",
  "type": "HASHI_CORP",
  "url": "https://vault.example.com:8200/",
  "auth": {
    "mechanism": "TOKEN",
    "secret": "[REDACTED]"
  },
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault/{KEY-VAULT-ID}",
      "rel": "self"
    }
  ]
}

돌아가기

만들기

삭제