Recupera las configuraciones de todos los almacenes de claves.
Roles necesarios
Puede llamar a este endpoint con éxito con cualquiera de los siguientes roles asignados:
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin
Resource
GET /keyVault
Parámetros de ruta de solicitud
Este endpoint no utiliza parámetros de ruta de solicitud HTTP.
Parámetros de Solicitud Query
Nombre | Tipo | Necesidad | Descripción | predeterminado |
|---|---|---|---|---|
Num. de pág. | Número | Opcional | Entero basado en uno que devuelve una subsección de resultados. |
|
elementosPorPágina | Número | Opcional | Número de elementos a devolver por página, hasta un máximo de 500. |
|
bonito | booleano | Opcional | Indicador que señala si el cuerpo de la respuesta debe estar en formato prettyprint. |
|
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 o al código de estado. Para remediarlo, establezca Para los endpoints que devuelven una lista de resultados, el objeto |
|
Parámetros del cuerpo de la solicitud
Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.
Respuesta
Documento de respuesta
El documento de respuesta JSON incluye un arreglo de objetos result, un arreglo de objetos link y un recuento del número total de objetos result recuperados.
Nombre | Tipo | Descripción |
|---|---|---|
| arreglo | El arreglo incluye un objeto para cada elemento detallado en la sección del |
| arreglo | El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web. |
| Número | Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado. |
results embeddedDocument
Cada resultado es una configuración de almacén de claves.
Nombre | Tipo | Descripción |
|---|---|---|
ID | string | Identificador único que MongoDB Ops Manager genera para esta configuración de key vault. Utilice este valor como |
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 |
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:
|
auth.secret | string | Credenciales que MongoDB Ops Manager utiliza para autenticarse en HashiCorp Vault. MongoDB Ops Manager cifra este valor en reposo y devuelve |
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 |
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 |
enlaces | objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos |
Solicitud de ejemplo
curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET 'https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true'
Respuesta de ejemplo
Encabezado de respuesta
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
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
{ "links": [ { "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/keyVault?pretty=true&pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "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" } ] } ], "totalCount": 1 }