Acesso programático ao Cloud Manager
- A autenticação OAuth 2.0 para acesso programático ao Cloud Manager 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 usar a 2.0 autenticação OAuth, crie uma conta de serviço para usar em suas solicitações para a API pública do Cloud Manager .
Para conceder acesso programático a uma organização ou projeto usando apenas a API, você pode criar uma chave deAPI . Chaves de API :
Tenha duas partes: uma chave pública e uma chave privada.
Não pode ser usado para fazer login no Cloud Manager por meio da interface do usuário.
Devem receber funções como você faria com os usuários, para garantir que as chaves de API possam chamar os endpoints de API sem erros.
Pode pertencer a uma organização, mas pode ter acesso a qualquer número de projetos nessa organização.
Manage Programmatic Access to an Organization
Observação
Permissões necessárias
Para executar qualquer uma das seguintes ação, você deve ter o role Organization Owner .
Criar uma chave de API em uma organização
No MongoDB Cloud Manager, váGo para a Organization Settings página.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Clique no ícone Organization Settings próximo ao menu Organizations.
A página Configurações da organização é exibida.
Vá para a página.<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \"Organization Access Manager fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">
Clique em Access Manager na barra lateral.
A página Organization Access Manager é exibida.
Preencha o API Key Information formulário.
Na etapa API Key Information da página Add API Key :
Campo | Valor |
|---|---|
Descrição | Insira uma descrição para a nova chave de API . |
Permissões da organização | Selecione o novo role ou roles para a chave API . |
Adicione valores de lista de acesso para esta chave de API.
Na etapa Private Key & Access List da página Add API Key , clique em Add Access List Entry.
Para esta chave de API , você pode optar por:
Insira um endereço IPv4 do qual o Cloud Manager deve aceitar solicitações de API , ou
Clique em Use Current IP Address se o host que você está usando para acessar o Cloud Manager fizer solicitações de API .
Clique em.<a class=\" \" href=\" \"Save title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">
Aviso
Copie a chave privada antes de sair desta página
Cloud Manager exibe o Private Key uma vez: nesta página. Clique em Copy para adicionar a Chave Privada à área de transferência. Salve e proteja esta Chave Privada como faria com qualquer outra senha.
Ver os detalhes de uma chave API em uma organização
No MongoDB Cloud Manager, váGo para a Organization Settings página.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Clique no ícone Organization Settings próximo ao menu Organizations.
A página Configurações da organização é exibida.
Vá para a página.<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \"Organization Access Manager fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">
Clique em Access Manager na barra lateral.
A página Organization Access Manager é exibida.
Navegue até View Details.
Ao lado da chave API , clique em .
Clique em View Details.
O modal <Public Key> API Key Details exibe o:
Private Key ofuscado.
Data em que a chave foi usada pela última vez.
Data em que a chave foi criada.
Endereços IPv4 nos quais a chave está na lista de acesso.
projeto aos quais a Chave recebeu acesso.
Alterar uma chave API em uma organização
Você pode alterar as funções, a descrição ou a lista de acesso de uma chave de API em uma organização.
No MongoDB Cloud Manager, váGo para a Organization Settings página.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Clique no ícone Organization Settings próximo ao menu Organizations.
A página Configurações da organização é exibida.
Vá para a página.<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \"Organization Access Manager fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">
Clique em Access Manager na barra lateral.
A página Organization Access Manager é exibida.
Preencha o API Key Information formulário.
Na etapa API Key Information da página Add API Key :
Campo | Valor |
|---|---|
Descrição | Insira uma descrição para a nova chave de API . |
Permissões da organização | Selecione o novo role ou roles para a chave API . |
Adicione valores de lista de acesso para esta chave de API.
Na etapa Private Key & Access List da página Add API Key , clique em Add Access List Entry.
Para esta chave de API , você pode optar por:
Insira um endereço IPv4 do qual o Cloud Manager deve aceitar solicitações de API , ou
Clique em Use Current IP Address se o host que você está usando para acessar o Cloud Manager fizer solicitações de API .
Clique em.<a class=\" \" href=\" \"Save title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">
Aviso
Copie a chave privada antes de sair desta página
Cloud Manager exibe o Private Key uma vez: nesta página. Clique em Copy para adicionar a Chave Privada à área de transferência. Salve e proteja esta Chave Privada como faria com qualquer outra senha.
Excluir uma chave API de uma Organização
No MongoDB Cloud Manager, váGo para a Organization Settings página.
Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.
Clique no ícone Organization Settings próximo ao menu Organizations.
A página Configurações da organização é exibida.
Vá para a página.<a class=\" \" href=\" \" title=\" \"><svg xmlns=\" \" width=\" \" height=\" \"Organization Access Manager fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">
Clique em Access Manager na barra lateral.
A página Organization Access Manager é exibida.
Excluir a chave API.
Clique em ao lado da chave de API que você deseja excluir.
Clique em Delete para confirmar que você deseja excluir esta chave API ou Cancel para deixar a chave na organização.
Observação
Remover uma chave de API de uma organização também remove essa chave de todos os projeto aos quais a chave recebeu acesso.
Managed acesso de programação a um projeto
Observação
Permissões necessárias
Para executar qualquer uma das seguintes ação, você deve ter o role Project User Admin .
Crie uma chave de API para um projeto
No MongoDB Cloud Manager, váGo para a Project Access Manager página.
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.
Preencha o API Key Information formulário.
Na etapa API Key Information da página Add API Key :
Campo | Valor |
|---|---|
Descrição | Insira uma descrição para a nova chave de API . |
Permissões do projeto | Selecione o novo role ou roles para a chave API . |
Adicione valores de lista de acesso para esta chave de API.
Na etapa Private Key & Access List da página Add API Key , clique em Add Access List Entry.
Para esta chave de API , você pode optar por:
Insira um endereço IPv4 do qual o Cloud Manager deve aceitar solicitações de API , ou
Clique em Use Current IP Address se o host que você está usando para acessar o Cloud Manager fizer solicitações de API .
Clique em.<a class=\" \" href=\" \"Save title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">
Aviso
Copie a chave privada antes de sair desta página
Cloud Manager exibe o Private Key uma vez: nesta página. Clique em Copy para adicionar a Chave Privada à área de transferência. Salve e proteja esta Chave Privada como faria com qualquer outra senha.
Ver os detalhes de uma chave API em um projeto
No MongoDB Cloud Manager, váGo para a Project Access Manager página.
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.
Navegue até View Details.
Ao lado da chave API , clique em .
Clique em View Details.
O modal <Public Key> API Key Details exibe o:
Private Key ofuscado.
Data em que a chave foi usada pela última vez.
Data em que a chave foi criada.
Endereços IPv4 nos quais a chave está na lista de acesso.
projeto aos quais a Chave recebeu acesso.
Alterar as funções de uma chave API em um projeto
No MongoDB Cloud Manager, váGo para a Project Access Manager página.
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.
Preencha o API Key Information formulário.
Na etapa API Key Information da página Add API Key :
Campo | Valor |
|---|---|
Descrição | Insira uma descrição para a nova chave de API . |
Permissões do projeto | Selecione o novo role ou roles para a chave API . |
Adicione valores de lista de acesso para esta chave de API.
Na etapa Private Key & Access List da página Add API Key , clique em Add Access List Entry.
Para esta chave de API , você pode optar por:
Insira um endereço IPv4 do qual o Cloud Manager deve aceitar solicitações de API , ou
Clique em Use Current IP Address se o host que você está usando para acessar o Cloud Manager fizer solicitações de API .
Clique em.<a class=\" \" href=\" \"Save title=\" \"><svg xmlns=\" \" width=\" \" height=\" \" fill=\" \" viewbox=\" \" class=\" \" role=\" \" aria-label=\" \"><path fill=\" \" d=\" \"> <path fill=\" \" d=\" \">
Aviso
Copie a chave privada antes de sair desta página
Cloud Manager exibe o Private Key uma vez: nesta página. Clique em Copy para adicionar a Chave Privada à área de transferência. Salve e proteja esta Chave Privada como faria com qualquer outra senha.
Excluir uma chave API de um projeto
No MongoDB Cloud Manager, váGo para a Project Access Manager página.
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.
Excluir a chave API.
Clique em ao lado da chave de API que você deseja excluir.
Clique em Delete para confirmar que você deseja excluir esta chave API ou Cancel para deixar a chave na organização.
Observação
Remover uma chave de API de uma organização também remove essa chave de todos os projeto aos quais a chave recebeu acesso.