atlas API programmaticApiKeys createApiKeyAccessList

O suporte do Atlas CLI para executar comandos com a API de administração do Atlas está em visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

Visualização pública: forneça comentários: Cria as entradas da lista de acesso para a chave de API da organização especificada.

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 comentários em https://feedback.mongodb.com/forums/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.

Os recursos exigem que todas as solicitações de API sejam originadas dos endereços IP na lista de acesso à API. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de leitura e gravação.

Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/createapikeyaccesslist.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe

Sintaxe do comando

atlas api programmaticApiKeys createApiKeyAccessList [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--apiUserId	string	true	String exclusiva de 24 dígitos hexadecimais que identifica essa chave API da organização para a qual você deseja criar uma nova entrada da lista de acesso.
--envelope	envelope	false	Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta.
--file	string	false	caminho para seu arquivo de solicitação de API. Deixe vazio para usar a entrada padrão - você deve fornecer um ou outro, mas não ambos.
-h, --help		false	ajuda para createApiKeyAccessList
--includeCount		false	Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
--itemsPerPage	int	false	Número de itens que a resposta retorna por página.
--orgId	string	true	String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas as organizações às quais o usuário autenticado tem acesso.
-o, --output	string	false	formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".
--outputFile	string	false	no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip)
--pageNum	int	false	Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.
--pretty		false	Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
--version	string	false	Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01".

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.