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

Atlas organização apiKeys atribuir

Nesta página

  • Sintaxe
  • argumentos
  • Opções
  • Opções herdadas
  • Saída
  • Exemplos

Modifique os roles ou a descrição da chave de API da organização especificada.

Ao modificar os roles de uma chave de API da organização com esse comando, os valores especificados substituem os roles existentes atribuídos à chave de API.

Para visualizar possíveis valores para o argumento apiKeyId, execute a Atlas organização apiKeys list.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de administrador do usuário da organização.

Sintaxe do comando
atlas organizations apiKeys assign <apiKeyId> [options]
Nome
Tipo
Obrigatório
Descrição
apiKeyId
string
true
Sequência única de 24 dígitos que identifica sua chave API.
Nome
Tipo
Obrigatório
Descrição
--desc
string
false
Descrição da chave API.
-h, --help
false
ajuda para atribuir
--orgId
string
false
ID da organização a ser usada. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.
-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
false
Função ou funções que você deseja atribuir à chave de API. Para atribuir mais de uma função, especifique cada função com um sinalizador de função separado ou especifique todas as funções como uma lista separada por vírgula usando um sinalizador de função. Para saber quais valores o CLI aceita, consulte o Enum de itens para roles nas especificações da API do Atlas: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/ #tag/Programmatic-API-Keys/operation/createApiKey/. A passagem deste sinalizador substitui os dados preexistentes.
Nome
Tipo
Obrigatório
Descrição
-P, --profile
string
false

Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.

API Key '<Id>' successfully updated.
# Modify the role and description for the API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345:
atlas organizations apiKeys assign 5f24084d8dbffa3ad3f21234 --role ORG_MEMBER --desc "User1 Member Key" --orgId 5a1b39eec902201990f12345 --output json

Voltar

Lista