Visualização pública: forneça comentários: retorna uma entrada 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 este recurso, a conta de serviço ou chave de API solicitante deve ter a função de membro da organizaçã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/operation-getapikeyaccesslist.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api programmaticApiKeys getApiKeyAccessList [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--apiUserId | string | true | String exclusiva de 24 dígitos hexadecimais que identifica a chave de API da organização para a qual você deseja retornar entradas 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. |
-h, --help | false | ajuda para getApiKeyAccessList | |
--ipAddress | string | true | Um endereço IP ou vários endereços IP representados como um bloco CIDR para limitar as solicitações aos recursos da API na organização especificada. Ao adicionar um bloco CIDR com uma máscara de sub-rede, como 192.0.2.0/24, use o valor codificado por URL %2F para a barra /. |
--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) |
--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. |
Exemplos
atlas api programmaticApiKeys getApiKeyAccessList --version 2023-01-01 --apiUserId [apiUserId] --ipAddress 192.0.2.0%2F24 --orgId 4888442a3354817a7320eb61