Managed acesso de programação a um projeto
Nesta página
- A autenticação OAuth 2.0 para acesso programático ao Atlas está disponível como um recurso de visualização.
- O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para utilizar a 2.0 autenticação OAuth, crie uma conta de serviço do para utilizar em seus pedidos para a API de Administração do Atlas .
Siga os procedimentos a seguir para managed o acesso programático a um projeto. Para saber mais, consulte Conceder acesso programático a um projeto.
Acesso necessário
Para executar qualquer uma das seguintes ação, você deve ter acesso do Project Owner ao projeto.
Visualizar acesso de programação a um projeto
Você pode visualizar os detalhes de todas as chaves deAPI ou contas de serviço que têm acesso ao seu projeto.
Para listar todas as chaves API para seu projeto utilizando o Atlas CLI, execute o seguinte comando:
atlas projects apiKeys list [options]
Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do Atlas CLI paraa lista de apiKeys de projetosdo Atlas .
Você pode visualizar as entradas da lista de acesso à API para uma chave de API do projeto utilizando um comando atlas organizations .
Para listar as entradas da lista de acesso IP para sua chave API usando o Atlas CLI, execute o seguinte comando:
atlas organizations apiKeys accessLists list <apiKeyID> [options]
Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do Atlas CLI para Atlas organizations apiKeys accessLists list.
Para visualizar os detalhes de uma chave API em um projeto usando a UI do Atlas :
No Atlas, acesse a página Project Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Execute uma das seguintes etapas:
Selecione Project Access no menu Access Manager na barra de navegação.
Ao lado do menu Projects, expanda o menu Options, clique em Project Settings e clique em Access Manager na barra lateral.
A página Project Access Manager (Gerente de acesso do projeto) é exibida.
Veja a lista de acesso.
Clique em à direita da chave API .
Clique em View Details.
O modal <Public Key> API Key Details exibe as seguintes informações:
O ofuscado Private Key
A data em que a chave foi usada pela última vez
A data em que a chave foi criada
O endereço ou endereços IP a partir dos quais a chave de API pode acessar a API
Para visualizar os detalhes de uma conta de serviço em um projeto usando a UI do Atlas :
No Atlas, acesse a página Project Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Execute uma das seguintes etapas:
Selecione Project Access no menu Access Manager na barra de navegação.
Ao lado do menu Projects, expanda o menu Options, clique em Project Settings e clique em Access Manager na barra lateral.
A página Project Access Manager (Gerente de acesso do projeto) é exibida.
Clique em Service Accounts.
Todas as contas de serviço com acesso ao seu projeto estão listadas.
Clique no nome de uma conta de serviço para visualizar seus detalhes, incluindo:
O segredo ofuscado do cliente para a conta de serviço
A data em que o segredo do cliente foi usado pela última vez
A data em que o segredo do cliente foi criado
Os endereços IP a partir dos quais a conta de serviço pode acessar a API
Os roles que a conta de serviço recebeu
Você pode usar a API de Administração do Atlas para listar os nomes e detalhes das contas de serviço que têm acesso ao seu projeto.
Alterar funções de acesso programático para um projeto
No Atlas, acesse a página Project Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Execute uma das seguintes etapas:
Selecione Project Access no menu Access Manager na barra de navegação.
Ao lado do menu Projects, expanda o menu Options, clique em Project Settings e clique em Access Manager na barra lateral.
A página Project Access Manager (Gerente de acesso do projeto) é exibida.
Selecione o novo role ou roles para a chave API no Project Permissions menu.
No Atlas, acesse a página Project Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Execute uma das seguintes etapas:
Selecione Project Access no menu Access Manager na barra de navegação.
Ao lado do menu Projects, expanda o menu Options, clique em Project Settings e clique em Access Manager na barra lateral.
A página Project Access Manager (Gerente de acesso do projeto) é exibida.
Edite o Project Permissions.
Clique em Edit Permissions.
No Project Permissions menu, selecione o novo role ou roles para a conta de serviço.
Clique em Save and next.
Importante
As credenciais da conta de serviço permanecem ativas até expirarem ou serem revogadas.
Você pode usar a API de administração do Atlas para atualizar os detalhes da conta de serviço de um projeto.
Editar lista de acesso do projeto
Você pode editar as entradas da lista de acesso à API para a chave de API do projeto usando os comandos atlas organizations .
Adicionar uma entrada da lista de acesso à API para a chave de API
Para criar uma entrada de lista de acesso IP para sua chave API utilizando o Atlas CLI, execute o seguinte comando:
atlas organizations apiKeys accessLists create [options]
Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do Atlas CLI para atlas organizations apiKeys accessLists create.
Excluir uma entrada da lista de acesso à API para a chave de API
Para excluir uma entrada de lista de acesso IP para sua chave API utilizando o Atlas CLI, execute o seguinte comando:
atlas organizations apiKeys accessLists delete <entry> [options]
Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do Atlas CLI para Atlas organizations apiKeys accessLists delete.
No Atlas, acesse a página Project Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Execute uma das seguintes etapas:
Selecione Project Access no menu Access Manager na barra de navegação.
Ao lado do menu Projects, expanda o menu Options, clique em Project Settings e clique em Access Manager na barra lateral.
A página Project Access Manager (Gerente de acesso do projeto) é exibida.
Edite o API Access List.
Não é possível modificar uma entrada da lista de acesso de chave API existente. Você deve excluí-lo e recriá-lo.
Clique em à direita do endereço IP para removê-lo.
Adicione o novo endereço IP ou bloco CIDR a partir do qual você deseja que o Atlas aceite solicitações de API para essa chave de API . Use uma das duas opções:
Clique em Add access list Entry e digite um endereço IP , ou
Clique em Use Current IP Address se o host que você está usando para acessar o Atlas também fizer solicitações de API usando essa chave de API .
Clique em Save.
No Atlas, acesse a página Project Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Execute uma das seguintes etapas:
Selecione Project Access no menu Access Manager na barra de navegação.
Ao lado do menu Projects, expanda o menu Options, clique em Project Settings e clique em Access Manager na barra lateral.
A página Project Access Manager (Gerente de acesso do projeto) é exibida.
Edite o API Access List.
Para adicionar um endereço IP ou bloco CIDR a partir do qual você deseja que o Atlas aceite solicitações de API para essa conta de serviço, clique em Add Access List Entry e digite um endereço IP.
Você também pode clicar Use Current IP Address em se o host que você está usando para acessar o Atlas também fizer solicitações de API usando essa conta de serviço.
Para remover um endereço IP da lista de acesso, clique em à direita do endereço IP .
Clique em Save.
Você pode usar a API de administração do Atlas para atualizar os detalhes da conta de serviço de um projeto.
Revogar acesso de programação a um projeto
Para excluir uma chave API para seu projeto utilizando o Atlas CLI, execute o seguinte comando:
atlas projects apiKeys delete <ID> [options]
Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do Atlas CLI para excluir projetos Atlas apiKeys.
Para excluir uma chave API de um projeto usando a UI do Atlas :
No Atlas, acesse a página Project Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Execute uma das seguintes etapas:
Selecione Project Access no menu Access Manager na barra de navegação.
Ao lado do menu Projects, expanda o menu Options, clique em Project Settings e clique em Access Manager na barra lateral.
A página Project Access Manager (Gerente de acesso do projeto) é exibida.
No Atlas, acesse a página Project Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.
Execute uma das seguintes etapas:
Selecione Project Access no menu Access Manager na barra de navegação.
Ao lado do menu Projects, expanda o menu Options, clique em Project Settings e clique em Access Manager na barra lateral.
A página Project Access Manager (Gerente de acesso do projeto) é exibida.
Você pode usar a API de administração do Atlas para remover uma conta de serviço de um projeto.