Menu Docs

mongocli iam organização apiKeys describe

Return the details for the specified API key for your organization.

Para visualizar os valores possíveis para o argumento ID, execute mongocli iam organizations 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 do comando
mongocli iam organizations apiKeys describe <ID> [options]
Nome
Tipo
Obrigatório
Descrição

ID

string

true

Sequência única de 24 dígitos que identifica sua chave API.

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.

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.

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>
# Return the JSON-formatted details for the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345:
mongocli iam organizations apiKeys describe 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345 -output json