Atualizar uma configuração de cofre de chaves

Atualiza uma configuração de cofre de chaves. O Ops Manager mescla os campos que você envia com a configuração armazenada e deixa os campos que você omite inalterados.

Funções obrigatórias

Exige que a chave API que chama este endpoint tenha o role Global Owner.

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

Resource

PATCH /keyVault/{KEY-VAULT-ID}

Parâmetros do caminho da solicitação

Nome	Tipo	Descrição
KEY-VAULT-ID	string	Identificador exclusivo da configuração do cofre de chaves a ser atualizada.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome	Tipo	necessidade	Descrição	Default
pretty	booleano	Opcional	Sinalizador que indica se o corpo da resposta está em um formato prettyprint.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deve envolver a resposta em um envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Para endpoints que retornam um resultado, o corpo da resposta inclui: `status`: Código de resposta HTTP `content`: Corpo de resposta esperado	`false`

Parâmetros do corpo da solicitação

Nome	Tipo	necessidade	Descrição
Nome amigável	string	Opcional	etiqueta legível por humanos que identifica esta configuração do cofre de chaves. O MongoDB Ops Manager exibe esse valor na lista Key Vault e no campo Vault Name.
type	string	Opcional	Tipo de provedor de cofre de chaves. O MongoDB Ops Manager aceita apenas `HASHI_CORP`, que representa o HashiCorp Vault.
URL	string	Opcional	Endereço do servidor HashiCorp Vault ao qual o Ops Manager se conecta, como `https://localhost:8200/`.
auth	objeto	Opcional	Detalhes de autenticação que o MongoDB Ops Manager usa para se conectar ao HashiCorp Vault.
auth.mechanism	string	Opcional	Método de autenticação que o gerente de operações usa para se conectar ao HashiCorp Vault. Forneça este campo somente quando você alterar o método de autenticação. Se você omitir este campo, o Ops Manager manterá o mecanismo armazenado. O Ops Manager aceita os seguintes valores: `TOKEN` `JWT`
auth.secret	string	Condicional	Credenciais que o gerente de operações usa para autenticar no HashiCorp Vault. Necessário quando você altera o `auth.mechanism`, pois o Ops Manager não pode reutilizar uma credencial nos métodos de autenticação. Quando `auth.mechanism` estiver `TOKEN`, defina esse valor para o token do Vault. Quando `auth.mechanism` for `JWT`, defina esse valor para a chave privada RSA formatada em PEM que assina o JWT. Quando você não alterar `auth.mechanism`, omita este campo ou envie o valor editado que o Ops Manager retorna para manter a credencial armazenada. O Ops Manager criptografa esse valor em repouso e o edita em respostas de API.
auth.jwtClaims	objeto	Condicional	Declarações que o gerente de operações envia quando solicita um login JWT do HashiCorp Vault. Obrigatório quando `auth.mechanism` é `JWT`. Inclua as declarações `user` e `role`.
customCertificates	array	Opcional	Lista de certificados de autoridade de certificação personalizados que o Ops Manager usa para verificação TLS quando se conecta ao servidor HashiCorp Vault.
customCertificates[n].filename	string	Condicional	Nome que identifica o arquivo PEM da Autoridade de certificação. Necessário para cada entrada no `customCertificates`.
customCertificates[n].certString	string	Condicional	Conteúdo do arquivo PEM da Autoridade de certificação. Necessário para cada entrada no `customCertificates`. Para manter um certificado armazenado, envie o valor editado que o Ops Manager retorna. O Ops Manager edita esse valor nas respostas da API.

Resposta

Nome	Tipo	Descrição
id	string	Identificador exclusivo que o MongoDB Ops Manager gera para esta configuração de cofre de chaves. Use este valor como o `vaultId` ao configurar um armazenamento de snapshots compatível com S3para usar este cofre de chaves.
Nome amigável	string	etiqueta legível por humanos que identifica esta configuração do cofre de chaves.
type	string	Tipo de provedor de cofre de chaves. O Ops Manager retorna `HASHI_CORP`, que representa o HashiCorp Vault.
URL	string	Endereço do servidor HashiCorp Vault ao qual o MongoDB Ops Manager se conecta.
auth	objeto	Detalhes de autenticação que o MongoDB Ops Manager usa para se conectar ao HashiCorp Vault.
auth.mechanism	string	Método de autenticação que o MongoDB Ops Manager usa para se conectar ao HashiCorp Vault. O MongoDB Ops Manager retorna um dos seguintes valores: `TOKEN` `JWT`
auth.secret	string	Credenciais que o MongoDB Ops Manager usa para autenticar no HashiCorp Vault. O MongoDB Ops Manager criptografa esse valor em repouso e retorna `[REDACTED]` em vez do valor armazenado.
auth.jwtClaims	objeto	Declarações que o gerente de operações envia quando solicita um login JWT do HashiCorp Vault. O Ops Manager retorna esse objeto somente quando `auth.mechanism` está `JWT`.
customCertificates	array	Lista de certificados de autoridade de certificação personalizados que o Ops Manager usa para verificação TLS quando se conecta ao servidor HashiCorp Vault.
customCertificates[n].filename	string	Nome que identifica o arquivo PEM da Autoridade de certificação.
customCertificates[n].certString	string	Conteúdo do arquivo PEM da Autoridade de certificação. O Ops Manager retorna `[REDACTED]` em vez do valor armazenado.
links	array de objetos	Um ou mais links para sub-recursos ou recursos relacionados. Todas as arrays `links` nas respostas incluem pelo menos um link chamado `self`. Os relacionamentos entre URLs são explicados na Especificação de links da web.

Exemplo de solicitação

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/"
     }'

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

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

Voltar

criar

Excluir