Manage Programmatic Access to an Organization
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 .
Use os procedimentos a seguir para managed o acesso programático a uma organização. Para saber mais, consulte Conceder acesso de programação a uma organização.
Acesso necessário
Para executar qualquer uma das seguintes ações, você deve ter acesso de Organization Owner ao Atlas.
Visualizar acesso de programação a uma organização
Você pode visualizar os detalhes de todas as chaves deAPI ou contas de serviço que têm acesso à sua organização.
Você pode visualizar uma lista de chaves API, os detalhes de uma chave API ou a lista de acesso para uma chave API em uma organização utilizando o Atlas CLI.
Ver Chaves API
Para listar todas as chaves API em uma organização usando o Atlas CLI, execute o seguinte comando:
atlas organizations apiKeys list [options]
Para retornar os detalhes de uma chave API em uma organização usando o Atlas CLI, execute o seguinte comando:
atlas organizations apiKeys describe <ID> [options]
Para saber mais sobre a sintaxe e os parâmetros dos comandos anteriores, consulte a documentação do Atlas CLI para Atlas organizations apiKeys list e Atlas organizations apiKeys describe.
Visualizar entradas da lista de acesso à API para a chave de API
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 uma organização usando a UI do Atlas :
No Atlas, acesse a página Organization Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Execute uma das seguintes etapas:
Selecione Organization Access no menu Access Manager na barra de navegação.
Clique em Access Manager na barra lateral.
A página Organization Access Manager é exibida.
Veja a lista de acesso.
Clique em à direita da chave API .
Clique em View Details.
O modal <Public Key> API Key Details exibe:
O ofuscado Private Key
A data em que a chave foi usada pela última vez
A data em que a chave foi criada
Os endereços IP a partir dos quais a chave pode acessar a API
Os projetos aos quais a Chave recebeu acesso
No Atlas, acesse a página Organization Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Execute uma das seguintes etapas:
Selecione Organization Access no menu Access Manager na barra de navegação.
Clique em Access Manager na barra lateral.
A página Organization Access Manager é exibida.
Clique em Service Accounts.
Todas as contas de serviço com acesso à sua organização 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 à sua organização.
Atualizar acesso de programação a uma organização
Você pode alterar as funções ou a lista de acesso de uma chave API em uma organização usando o Atlas CLI.
Alterar as Funções de uma Chave API
Para atualizar uma chave API em uma organização usando o Atlas CLI, execute o seguinte comando:
atlas organizations apiKeys assign <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 assign.
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.
Você pode alterar as funções, a descrição ou a lista de acesso de uma chave de API em uma organização usando a UI do Atlas .
No Atlas, acesse a página Organization Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Execute uma das seguintes etapas:
Selecione Organization Access no menu Access Manager na barra de navegação.
Clique em Access Manager na barra lateral.
A página Organization Access Manager é exibida.
Edite o API Key Information.
Na página Add API Key:
Modifique o Description.
No menu Organization Permissions, selecione a nova função ou funções para a chave de API.
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 chave de API , clique em Add Access list Entry e digite um endereço IP .
Você também pode clicar 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 .
Para remover um endereço IP da lista de acesso, clique em à direita do endereço IP .
Clique em Save.
Você pode alterar as funções, o nome, a descrição ou a lista de acesso de uma conta de serviço em uma organização usando a UI do Atlas . Você também pode gerar um novo segredo do cliente .
No Atlas, acesse a página Organization Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Execute uma das seguintes etapas:
Selecione Organization Access no menu Access Manager na barra de navegação.
Clique em Access Manager na barra lateral.
A página Organization Access Manager é exibida.
Gere um novo segredo do cliente .
Clique em Generate New Client Secret
Escolha uma duração para o segredo do cliente no menu. O segredo do cliente expira após essa duração.
Clique em Generate New.
Clique em Copy e salve o segredo do cliente em um local seguro. Esta é a única vez que você pode visualizar o segredo completo do cliente .
Edite o Organization Permissions.
Clique em Edit Permissions.
No Organization 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.
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 utilizar a API de Administração do Atlas para:
Revogar acesso de programação a uma organização
Para excluir uma chave API de uma organização usando o Atlas CLI, execute o seguinte comando:
atlas organizations apiKeys delete <ID> [options]
Para saber mais sobre a sintaxe e os parâmetros do comando, consulte a documentação do Atlas CLI para excluirAtlas organizations apiKeys.
Para excluir uma entrada da lista de acesso para uma chave API em uma organização, consulte Atualizar Acesso Programático a uma Organização.
No Atlas, acesse a página Organization Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Execute uma das seguintes etapas:
Selecione Organization Access no menu Access Manager na barra de navegação.
Clique em Access Manager na barra lateral.
A página Organization Access Manager é exibida.
No Atlas, acesse a página Organization Access Manager.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Execute uma das seguintes etapas:
Selecione Organization Access no menu Access Manager na barra de navegação.
Clique em Access Manager na barra lateral.
A página Organization Access Manager é exibida.
Você pode utilizar a API de Administração do Atlas para: