Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos da API de administração do Cloud Manager
/
Chaves de API programáticas
/
Chaves de API programáticas da organização

Atualizar uma chave API

Nesta página

  • Resource
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

URL base: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição
ORG-ID
string
Identificador único para aorganização cujas chaves deAPI do você deseja recuperar. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso.
API-KEY-ID
string
Identificador único da chave de API que você deseja atualizar. Solicite ao endpoint /orgs/{ORG-ID}/apiKeys que recupere todas as chaves de API às quais o usuário autenticado tem acesso para a organização especificada.

Solicitar parâmetros de query

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

Nome
Tipo
Descrição
default
pageNum
inteiro
Número da página (com base em índice 1).
1
itemsPerPage
inteiro
Número de itens a serem devolvidos por página, até um máximo de 500.
100
pretty
booleano
false
envelope
booleano

Indica se deseja ou não 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, configure "envelope" : true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição
status
Código de resposta HTTP
content
Corpo de resposta esperado

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Cloud Manager adiciona o campo status ao corpo da resposta.

none

Parâmetros do corpo da solicitação

Nome
Tipo
Obrigatório/Opcional
Descrição
desc
string
Opcional
Descrição da chave. Este parâmetro é opcional; no entanto, a solicitação deve conter um parâmetro desc ou um parâmetro roles . Se desc for fornecido, ele deverá ter entre 1 e 250 caracteres.
roles
array de strings
Opcional

Lista de funções que a chave API deve ter. Este parâmetro é opcional; no entanto, a solicitação deve conter um parâmetro desc ou um parâmetro roles . Se roles for fornecido, deve haver pelo menos uma função listada e todas as funções devem ser válidas para uma Organização.

As funções da organização incluem:

Valor da função na API
Função
ORG_OWNER
ORG_MEMBER
ORG_GROUP_CREATOR
ORG_BILLING_ADMIN
ORG_READ_ONLY

Resposta

Nome
Tipo
Descrição
id
string
Identificador exclusivo para a chave API
desc
string
Descrição da chave API
privateKey
string
Chave privada editada para a chave de API
publicKey
string
Chave pública para a chave de API
roles
array de objetos
Funções que a chave API tem
roles.{ENTITY-ID}
string
O {ENTITY-ID} representa a organização ou projeto ao qual esta função se aplica. Os valores possíveis são: orgId ou groupId.
roles.roleName
string

O nome da função. O recurso users retorna todos os papéis que o usuário tem no MongoDB Atlas ou Cloud Manager. Os valores possíveis são:

  • Roles da organização

    Valor da função na API
    Função
    ORG_OWNER
    ORG_MEMBER
    ORG_GROUP_CREATOR
    ORG_BILLING_ADMIN
    ORG_READ_ONLY

  • Roles do projeto

    Grupos e projetos são termos sinônimos.

    • GROUP_OWNER

    • GROUP_READ_ONLY

    • GROUP_DATA_ACCESS_ADMIN

    • GROUP_DATA_ACCESS_READ_WRITE

    • GROUP_DATA_ACCESS_READ_ONLY

    • GROUP_AUTOMATION_ADMIN

    • GROUP_BACKUP_ADMIN

    • GROUP_MONITORING_ADMIN

    • GROUP_OWNER

    • GROUP_USER_ADMIN

Exemplo de solicitação

Observação

O usuário que faz a solicitação pode ser formatado como {PUBLIC-KEY}:{PRIVATE-KEY}.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true" \
     --data '{
       "desc" : "Updated |api| key description for test purposes",
       "roles": ["ORG_MEMBER", "ORG_READ_ONLY"]
     }'

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

{
  "desc" : "Updated |api| key description for test purposes",
  "id" : "5c47ba5127d9d61b9fd8a27b",
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d12029d82e3f6/apiKeys/5c47ba5127d9d61b9fd8a27b",
    "rel" : "self"
  } ],
  "privateKey" : "********-****-****-db2c132ca78d",
  "publicKey" : "kzurbulc",
  "roles" : [ {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_MEMBER"
  }, {
    "orgId" : "5980cfc70b6d97029d82e3f6",
    "roleName" : "ORG_READ_ONLY"
  } ]
}

Voltar

Criar uma chave API