Menu Docs
Página inicial do Docs
/ /
MongoDB CLI
/ / /

mongocli iam globalApiKeys update

Nesta página

  • Sintaxe
  • argumentos
  • Opções
  • Opções herdadas
  • Exemplos

Modifique os roles e a descrição de uma chave de API global.

Sintaxe do comando
mongocli iam globalApiKeys update <ID> [options]
Nome
Tipo
Obrigatório
Descrição
ID
string
true
String exclusiva de 24 dígitos que identifica a chave de API global.
Nome
Tipo
Obrigatório
Descrição
--desc
string
true
Descrição da chave API.
-h, --help
false
ajuda para atualização
-o, --output
string
false
Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON.
--role
strings
true
Role ou roles que você deseja atribuir à chave de API. Para atribuir mais de uma função, você pode especificar cada função com um sinalizador de função separado ou especificar todas as funções como uma lista separada por vírgulas usando um sinalizador de função. Os valores válidos são GLOBAL_AUTOMATION_ADMIN, GLOBAL_BACKUP_ADMIN, GLOBAL_MONITORING_ADMIN, GLOBAL_OWNER, GLOBAL_READ_ONLY,GLOBAL_USER_ADMIN. A transferência desse sinalizador substitui os dados preexistentes.
Nome
Tipo
Obrigatório
Descrição
-P, --profile
string
false
Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para MongoCLI, consulte https://dochub.mongodb.org/core/atlas-cli-configuration-file.
# Modify the roles and description for the global API key with the ID 5f5bad7a57aef32b04ed0210:
mongocli iam globalApiKeys update 5f5bad7a57aef32b04ed0210 --desc "My Sample Global API Key" --role GLOBAL_MONITORING_ADMIN --output json

Voltar

Lista