/ /

/ /

キーボールト構成の更新

1 つのキーボールト構成を更新します。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	string	更新するキーボールト構成の一意識別子。

リクエストクエリパラメータ

次のクエリパラメータは任意です。

名前	タイプ	必要性	説明	default
pretty	ブール値	任意	レスポンス本体をpretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリでenvelope=trueを設定します。 1 つの結果を返すエンドポイントの場合、レスポンス本体には次のものが含まれます。 `status`: HTTP レスポンスコード `content`: 期待される応答本体	`false`

リクエストボディパラメータ

名前	タイプ	必要性	説明
friendlyName	string	任意	このキーボールト構成を識別する人間が判読できるラベル。MongoDB Ops Managerは、Key Vault リストと Vault Name フィールドにこの値を表示します。
タイプ	string	任意	キーボルトプロバイダータイプ。MongoDB Ops Manager は、HashiCorp Vault を表す `HASHI_CORP` のみ受け付けます。
URL	string	任意	MongoDB Ops Manager が接続する HashiCorp Vault サーバーのアドレス。例: `https://localhost:8200/`
認証	オブジェクト	任意	MongoDB Ops Manager が HashiCorp Vault に接続するために使用する認証詳細。
auth.mechanism	string	条件付き	MongoDB Ops Manager が HashiCorp Vault に接続するために使用する認証方法。`auth` オブジェクトを更新する場合に必要です。MongoDB Ops Manager は、次の値を受け入れます。 `TOKEN` `JWT`
auth.secret	string	任意	MongoDB Ops Manager が HashiCorp Vault に認証するために使用する認証情報。 `auth.mechanism` が `TOKEN` の場合は、この値を Vault トークンに設定します。`auth.mechanism`が`JWT` の場合は、 JWT に署名するPEM形式のRSA秘密キーにこの値を設定します。保存された認証情報を維持するには、このフィールドを省略するか、MongoDB Ops Manager が返すマスク化された値を送信します。MongoDB Ops Manager はこの値を保存中に暗号化し、API 応答でマスク化します。
auth.jwtClaims	オブジェクト	条件付き	MongoDB Ops Manager が HashiCorp Vault に JSON web token ログインをリクエストするときに送信するクレーム。`auth.mechanism`が`JWT`の場合は必要です。`user`と`role`のクレームを含めます。
customCertificates	配列	任意	MongoDB Ops Manager が HashiCorp Vault サーバーに接続する際に TLS 検証に使用するカスタム認証局証明書の一覧。
customCertificates[n].filename	string	条件付き	認証局PEMファイルを識別する名前。`customCertificates` の各エントリに必要です。
customCertificates[n].certString	string	条件付き	証明機関 PEM ファイルの内容。`customCertificates` の各エントリに必要です。保存された証明書を保持するには、Ops Manager が返すサニタイズされた値を送信します。MongoDB Ops Manager は API レスポンスでこの値を削除します。

応答

名前	タイプ	説明
id	string	MongoDB Ops Manager がこのキーヴォールト構成に対して生成する一意の識別子。このキーヴォールトを使用するように S3 互換ストレージ読み取りを構成する場合は、この値を `vaultId` として使用します。
friendlyName	string	このキーボールト構成を識別する、人間が判読できるラベル。
タイプ	string	キーボルトプロバイダータイプ。MongoDB Ops Manager は `HASHI_CORP` を返します。これは HashiCorp Vault を表します。
URL	string	MongoDB Ops Manager が接続する HashiCorp Vault サーバーのアドレス。
認証	オブジェクト	MongoDB Ops Manager が HashiCorp Vault に接続するために使用する認証詳細。
auth.mechanism	string	MongoDB Ops Manager が HashiCorp Vault に接続するために使用する認証方法。MongoDB Ops Manager は、次のいずれかの値を返します。 `TOKEN` `JWT`
auth.secret	string	MongoDB Ops Manager が HashiCorp Vault への認証に使用する認証情報。MongoDB Ops Manager はこの値を保存時に暗号化し、保存された値の代わりに `[REDACTED]` を返します。
auth.jwtClaims	オブジェクト	MongoDB Ops Manager が HashiCorp Vault に JSON web token ログインをリクエストするときに送信するクレーム。MongoDB Ops Manager は、`auth.mechanism` が `JWT` の場合にのみこのオブジェクトを返します。
customCertificates	配列	MongoDB Ops Manager が HashiCorp Vault サーバーに接続する際に TLS 検証に使用するカスタム認証局証明書の一覧。
customCertificates[n].filename	string	認証局PEMファイルを識別する名前。
customCertificates[n].certString	string	証明機関PEMファイルの内容。MongoDB Ops Manager は保存された値の代わりに`[REDACTED]`を返します。
Links	オブジェクト配列	サブリソースまたは関連リソースへの 1 つ以上のリンク。応答内のすべての `links` 配列には、`self` と呼ばれるリンクが少なくとも 1 つ含まれています。URLの関係は、Web リンク仕様で説明されています。

リクエストの例

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"
    }
  ]
}

戻る

作成

削除

キーボールト構成の更新

必須のロール

Resource

リクエスト パス パラメーター

リクエスト クエリ パラメータ

リクエスト ボディ パラメータ

応答

リクエストの例

応答例

応答ヘッダー

レスポンス本体

リクエストパスパラメーター

リクエストクエリパラメータ

リクエストボディパラメータ