Atlas organização apiKeys describe

Retorne os detalhes da chave de API especificada para sua organização.

Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.

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

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

Sintaxe

Sintaxe do comando

atlas organizations apiKeys describe <ID> [options]

argumentos

Nome	Tipo	Obrigatório	Descrição
ID	string	true	Sequência única de 24 dígitos que identifica sua chave API.

Opções

Nome	Tipo	Obrigatório	Descrição
-h, --help		false	ajuda para descrever
--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.

Opções herdadas

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 o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Saída

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

ID     DESCRIPTION   PUBLIC KEY    PRIVATE KEY
<Id>   <Desc>        <PublicKey>   <PrivateKey>

Exemplos

# Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345:
atlas organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json