Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Acesso programático ao Cloud Manager com uma conta de serviço

Para conceder acesso programático a uma organização ou projeto usando apenas a API, crie uma chave de API ou uma conta de serviço. Isso garante que as chaves e tokens de acesso que servem como nomes de usuário e senhas nunca sejam enviados pela rede. Chaves deAPI e contas de serviço:

  • Não pode ser usado para fazer login no Cloud Manager por meio da UI.

  • Deve receber funções como você faria com os usuários para garantir que as chaves da API e as contas de serviço possam chamar os pontos de extremidade da API sem erros.

  • Pertence a uma organização, mas pode ter acesso a qualquer número de projetos nessa organização.

Para saber mais sobre esses dois métodos de autenticação,consulte Autenticação.

Observação

Permissões necessárias

Você pode visualizar o acesso programático a uma organização com qualquer papel.

Para executar qualquer outra ação, você deve ter a Organization Owner função.

Use os procedimentos a seguir para conceder acesso programático a uma organização por meio de chaves de API ou de uma conta de serviço. Para aprender mais sobre esses dois métodos de autenticação, consulte Autenticação.

1
  1. Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.

  2. Na barra lateral, clique em Applications` sob o título Identity & Access.

A página Aplicativos é exibida.

2
3
  1. Insira um Name.

  2. Insira um Description.

  3. Selecione uma duração no menu Client Secret Expiration.

  4. No menu Permissões da organização, selecione a nova função ou funções para a conta de serviço.

4
5

O segredo do cliente atua como a senha na criação de tokens de acesso.

Aviso

Essa é a única vez em que você pode ver o segredo completo do cliente. Clique em Copy e salve-o em um local seguro. Caso contrário, você precisará gerar um novo segredo do cliente.

6
  1. Clique em Add Access List Entry.

  2. Insira um endereço IP ou bloco CIDR a partir do qual você deseja que o Cloud Manager aceite solicitações de API para essa conta de serviço.

    Você também pode clicar Use Current IP Address em se o host que você está usando para acessar o Cloud Manager também fizer solicitações de API usando essa conta de serviço.

  3. Clique em Save.

Você pode visualizar os detalhes de todas as chaves API ou contas de serviço que têm acesso à sua organização.

1
  1. Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.

  2. Na barra lateral, clique em Applications` sob o título Identity & Access.

A página Aplicativos é exibida.

2
3

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 alterar as funções, a descrição ou a lista de acesso de uma chave de API ou conta de serviço em uma organização. Você também pode gerar um novo segredo do cliente para uma conta de serviço.

1
  1. Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.

  2. Na barra lateral, clique em Applications` sob o título Identity & Access.

A página Aplicativos é exibida.

2
3
4

Para modificar o Name ou Description, clique em .

5
  1. Clique em Generate New Client Secret

  2. Escolha uma duração para o segredo do cliente no menu. O segredo do cliente expira após essa duração.

  3. Clique em Generate New.

  4. 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 .

6
  1. Clique em Edit Permissions.

  2. No Organization Permissions menu, selecione o novo role ou roles para a conta de serviço.

  3. Clique em Save and next.

    Importante

    As credenciais da conta de serviço permanecem ativas até que expirem ou um usuário as revogue.

7
  1. Para adicionar um endereço IP ou bloco CIDR do qual você deseja que o Cloud Manager aceite solicitações de API para esta 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 Cloud Manager também fizer solicitações de API usando essa conta de serviço.

  2. Para remover um endereço IP da lista de acesso, clique em à direita do endereço IP .

  3. Clique em Save.

1
  1. Se ainda não estiver exibido, selecione sua organização desejada no Menu Organizations na barra de navegação.

  2. Na barra lateral, clique em Applications` sob o título Identity & Access.

A página Aplicativos é exibida.

2
3
  1. Click the icon under Actions to the right of the service account you want to delete.

  2. Clique em Delete.

Excluir uma conta de serviço de uma organização também a remove de todos os projetos aos quais a conta de serviço recebeu acesso.

Observação

Permissões necessárias

Você pode visualizar o acesso de programação a um projeto com qualquer função.

Para executar qualquer outra ação, você deve ter a Project User Admin função.

Use os procedimentos a seguir para conceder acesso programático a um projeto por meio de chaves de API ou de uma conta de serviço. Para aprender mais sobre esses dois métodos de autenticação, consulte Autenticação.

1
  1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.

  2. Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.

  3. Na barra lateral, clique em Project Settings.

    A página Configurações do projeto é exibida.

2

Na barra lateral, clique em Applications sob o título Identity & Access.

A página Aplicativos é exibida.

3
4
  1. Insira um Name.

  2. Insira um Description.

  3. Selecione uma duração no menu Client Secret Expiration.

  4. No menu Permissões do projeto, selecione a nova função ou funções da conta de serviço.

5
6

O segredo do cliente atua como a senha na criação de tokens de acesso.

Aviso

Essa é a única vez em que você pode ver o segredo completo do cliente. Clique em Copy e salve-o em um local seguro. Caso contrário, você precisará gerar um novo segredo do cliente.

7
  1. Clique em Add Access List Entry.

  2. Insira um endereço IP ou bloco CIDR a partir do qual você deseja que o Cloud Manager aceite solicitações de API para essa conta de serviço.

    Você também pode clicar Use Current IP Address em se o host que você está usando para acessar o Cloud Manager também fizer solicitações de API usando essa conta de serviço.

  3. Clique em Save.

Você pode visualizar os detalhes de todas as chaves de API ou contas de serviço que têm acesso ao seu projeto.

1
  1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.

  2. Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.

  3. Na barra lateral, clique em Project Settings.

    A página Configurações do projeto é exibida.

2

Na barra lateral, clique em Applications sob o título Identity & Access.

A página Aplicativos é exibida.

3

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

1
  1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.

  2. Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.

  3. Na barra lateral, clique em Project Settings.

    A página Configurações do projeto é exibida.

2

Na barra lateral, clique em Applications sob o título Identity & Access.

A página Aplicativos é exibida.

3
4
5

Para modificar o Name ou Description, clique em .

6
  1. Clique em Generate New Client Secret

  2. Escolha uma duração para o segredo do cliente no menu. O segredo do cliente expira após essa duração.

  3. Clique em Generate New.

  4. 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 .

7
  1. Clique em Edit Permissions.

  2. No Project Permissions menu, selecione o novo role ou roles para a conta de serviço.

  3. Clique em Save and next.

    Importante

    As credenciais da conta de serviço permanecem ativas até que expirem ou um usuário as revogue.

8
  1. Para adicionar um endereço IP ou bloco CIDR do qual você deseja que o Cloud Manager aceite solicitações de API para esta 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 Cloud Manager também fizer solicitações de API usando essa conta de serviço.

  2. Para remover um endereço IP da lista de acesso, clique em à direita do endereço IP .

  3. Clique em Save.

1
  1. Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.

  2. Se ainda não estiver exibido, selecione o projeto desejado no menu Projects na barra de navegação.

  3. Na barra lateral, clique em Project Settings.

    A página Configurações do projeto é exibida.

2

Na barra lateral, clique em Applications sob o título Identity & Access.

A página Aplicativos é exibida.

3
4
  1. Click the icon under Actions to the right of the service account you want to remove from the project.

  2. Clique em Remove from this project.

Importante

A conta de serviço ainda existe na organização e quaisquer credenciais existentes permanecem ativas até expirarem ou revogadas manualmente.

A API do Cloud Manager usa um dos dois métodos de autenticação para autenticar solicitações: chaves deAPI ou uma conta de serviço. Você precisará das chaves ou do segredo que salvou ao configurar seu método de autenticação preferido para concluir os procedimentos a seguir.

Para fazer uma solicitação de API usando uma conta de serviço, use a conta de serviço para gerar um token de acesso e, em seguida, use o token de acesso em sua solicitação:

1

Localize o segredo do cliente que começa com mdb_sa_sk_ que você salvou imediatamente após criar a conta de serviço, que foi a única vez que você pôde visualizar o segredo do cliente. Se você não salvou o segredo do cliente, deve gerar um novo.

2

Por exemplo, execute:

echo -n {clientId}:{clientSecret} | base64 -w0
3

Substitua {base64Auth} no exemplo a seguir pela saída da etapa anterior e execute:

curl --request POST \ --url https://cloud.mongodb.com/api/oauth/token \ --header 'accept: application/json' \ --header 'cache-control: no-cache' \ --header 'authorization: Basic {base64Auth}' \ --header 'content-type: application/x-www-form-urlencoded' \ --data 'grant_type=client_credentials'
{"access_token":"{accessToken}""expires_in":3600,"token_type":"Bearer"}%

Importante

O token de acesso é válido por 1 hora (3600 segundos). Você não pode atualizar um token de acesso. Quando esse token de acesso expirar, repita essa etapa para gerar um novo.

4

Substitua {accessToken} no exemplo a seguir pela saída da etapa anterior. Por exemplo, --header 'Authorization: Bearer eyJ...pSnF' \.

A seguinte amostra de solicitação GET retorna todos os projetos para o usuário atual:

curl --request GET \ --url https://cloud.mongodb.com/api/public/v1.0/groups \ --header 'Authorization: Bearer {accessToken}' \ --header 'Accept: application/json' \

A seguinte amostra de solicitação POST recebe um corpo da solicitação e cria um projeto denominado MyProject na sua organização:

curl --header 'Authorization: Bearer {accessToken}' \ --header 'Content-Type: application/json' \ --header 'Accept: application/json' \ --include \ --request POST 'https://cloud.mongodb.com/api/public/v1.0/groups' \ --data ' { "name": "MyProject", "orgId": "5a0a1e7e0f2912c554080adc" }'