Docs Home

/ /

Key Vault

Docs Home

/ /

Administración de copias de seguridad

Key Vault

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Administración de copias de seguridad

Key Vault

Crear una configuración de One Key Vault

Crea una configuración de almacén de claves que MongoDB Ops Manager utiliza para leer las credenciales de HashiCorp Vault.

Roles necesarios

Requiere que la clave API que llame a este endpoint tenga el rol Global Owner.

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

Resource

POST /keyVault

Parámetros de ruta de solicitud

Este endpoint no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
bonito	booleano	Opcional	Indicador que muestra si el cuerpo de la respuesta está en formato pretty-print.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye: `status`: Código de respuesta HTTP `content`: Cuerpo de respuesta esperado	`false`

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Necesidad	Descripción
friendlyName	string	Requerido	Etiqueta legible por humanos que identifica esta configuración de almacén de claves. Ops Manager muestra este valor en la lista Key Vault y en el campo Vault Name.
tipo	string	Requerido	Tipo de proveedor de Key Vault. MongoDB Ops Manager solo acepta `HASHI_CORP`, que representa HashiCorp Vault.
URL	string	Requerido	Dirección del servidor de HashiCorp Vault al que se conecta Ops Manager, como `https://localhost:8200/`.
auth	Objeto	Requerido	Detalles de autenticación que MongoDB Ops Manager utiliza para conectarse a HashiCorp Vault.
auth.mechanism	string	Requerido	Método de autenticación que utiliza Ops Manager para conectarse a HashiCorp Vault. Ops Manager acepta los valores siguientes: `TOKEN` `JWT`
auth.secret	string	Requerido	Credenciales que MongoDB Ops Manager utiliza para autenticarse en HashiCorp Vault. Cuando `auth.mechanism` es `TOKEN`, establezca este valor en el token de Vault. Cuando `auth.mechanism` es `JWT`, establezca este valor en la llave privada RSA con formato PEMque firma el JWT. MongoDB Ops Manager cifra este valor en reposo y lo redacta en las respuestas de la API.
auth.jwtClaims	Objeto	Condicional	Afirmaciones que MongoDB Ops Manager envía cuando solicita un inicio de sesión de JSON web token de HashiCorp Vault. Obligatorio cuando `auth.mechanism` es `JWT`. Incluya las afirmaciones `user` y `role`.
cerfiticados personalizados	arreglo	Opcional	Lista de certificados de autoridad de certificación personalizados que MongoDB Ops Manager utiliza para la verificación de TLS cuando se conecta al servidor de HashiCorp Vault.
customCertificates[n].filename	string	Condicional	Nombre que identifica el archivo PEM de la Autoridad de Certificación. Obligatorio para cada entrada en `customCertificates`.
customCertificates[n].certString	string	Condicional	Contenido del archivo PEM de la Autoridad de Certificación. Obligatorio para cada entrada en `customCertificates`. Ops Manager redacta este valor en las respuestas de la API.

Respuesta

Nombre	Tipo	Descripción
ID	string	Identificador único que MongoDB Ops Manager genera para esta configuración de key vault. Utilice este valor como `vaultId` cuando configure un almacenamiento de snapshot compatible con S3para usar este key vault.
friendlyName	string	Etiqueta legible por humanos que identifica esta configuración de bóveda de claves.
tipo	string	Tipo de proveedor de Key Vault. MongoDB Ops Manager devuelve `HASHI_CORP`, que representa HashiCorp Vault.
URL	string	Dirección del servidor de HashiCorp Vault al que se conecta MongoDB Ops Manager.
auth	Objeto	Detalles de autenticación que MongoDB Ops Manager utiliza para conectarse a HashiCorp Vault.
auth.mechanism	string	Método de autenticación que utiliza Ops Manager para conectarse a HashiCorp Vault. MongoDB Ops Manager devuelve uno de los siguientes valores: `TOKEN` `JWT`
auth.secret	string	Credenciales que MongoDB Ops Manager utiliza para autenticarse en HashiCorp Vault. MongoDB Ops Manager cifra este valor en reposo y devuelve `[REDACTED]` en lugar del valor almacenado.
auth.jwtClaims	Objeto	Afirmaciones que MongoDB Ops Manager envía cuando solicita un inicio de sesión de JSON web token de HashiCorp Vault. MongoDB Ops Manager devuelve este objeto solo cuando `auth.mechanism` es `JWT`.
cerfiticados personalizados	arreglo	Lista de certificados de autoridad de certificación personalizados que MongoDB Ops Manager utiliza para la verificación de TLS cuando se conecta al servidor de HashiCorp Vault.
customCertificates[n].filename	string	Nombre que identifica el archivo PEM de la Autoridad de Certificación.
customCertificates[n].certString	string	Contenido del archivo PEM de la Autoridad de Certificación. MongoDB Ops Manager devuelve `[REDACTED]` en lugar del valor almacenado.
enlaces	objeto arreglo	Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos `links` en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre las URLse explican en la Especificación de enlace web.

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request POST 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true' \
     --data '{
       "friendlyName": "myVault",
       "type": "HASHI_CORP",
       "url": "https://localhost:8200/",
       "auth": {
         "mechanism": "TOKEN",
         "secret": "<vault-token>"
       }
     }'

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request POST 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true' \
     --data '{
       "friendlyName": "myVault",
       "type": "HASHI_CORP",
       "url": "https://localhost:8200/",
       "auth": {
         "mechanism": "JWT",
         "secret": "-----BEGIN PRIVATE KEY-----\n<private-key>\n-----END PRIVATE KEY-----",
         "jwtClaims": {
           "user": "ops-manager",
           "role": "ops-manager-role"
         }
       }
     }'

Respuesta de ejemplo

Encabezado de respuesta

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}

Respuesta del cuerpo

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

Volver

Obtener todo

Update