Retornar todos os utilizadores de banco de dados em um projeto

OBTER /api/atlas/v2/groups/{groupId}/databaseUsers

Retorna todos os usuários de banco de dados que pertencem ao projeto especificado. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função somente leitura do projeto.

parâmetros de caminho

  • groupId string Obrigatório

    Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint /groups para extrair todos os projetos aos quais o usuário autenticado tem acesso.

    AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.

    O formato deve corresponder ao seguinte padrão: ^([a-f0-9]{24})$.

parâmetros de query

  • envelope booleano

    Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON 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 consulta. 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.

    O valor padrão é false.

  • incluir contagem booleano

    Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.

    O valor padrão é true.

  • itemsPerPage inteiro

    Número de itens que a resposta retorna por página.

    O valor mínimo é 1, o valor máximo é 500. O valor padrão é 100.

  • pageNum inteiro

    Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

    O valor mínimo é 1. O valor padrão é 1.

  • pretty booleano

    Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.

    O valor padrão é false.

    Prettyprint

Respostas

  • 200 application/vnd.atlas.2023-01-01+json

    OK

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • Resultados array[objeto]

      Lista de documentos retornados que o MongoDB Cloud fornece ao concluir esta solicitação.

      Ocultar atributos de resultados Mostrar atributos de resultados objeto
      • awsIAMType string

        Rótulo legível por humanos que indica se o novo usuário do banco de dados se autentica com as credenciais do Amazon Web Services (AWS) Identity and Access Management (IAM) associadas ao usuário ou à função do usuário.

        Os valores são NONE, USER ou ROLE. O valor padrão é NONE.

      • Nome do Banco de Dados string Obrigatório

        O banco de dados no qual o utilizador de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para fazer login no MongoDB. Se o usuário se autenticar com Amazon Web Services IAM, x.509, LDAP ou OIDC Workload, esse valor deverá ser $external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá ser admin.

        Os valores são admin ou $external. O valor padrão é admin.

      • deleteAfterDate string(data-hora)

        Data e hora em que o MongoDB Cloud exclui o usuário. Este parâmetro expressa seu valor no formato de registro de data/hora ISO 8601 em UTC e pode incluir a designação de zona. Você deve especificar uma data futura que caia dentro de uma semana após fazer a solicitação de Interface de Programação de Aplicativo (API).

      • Descrição string

        Descrição deste usuário de banco de dados.

        O comprimento máximo é 100.

      • rótulos array[objeto]

        Lista que contém os pares de valores-chave para marcar e categorizar o usuário do banco de dados MongoDB. Os rótulos que você define não aparecem no console.

        Rótulos legíveis por humanos aplicados a este componente MongoDB Cloud.

        Ocultar atributos de rótulos Mostrar atributos de rótulos objeto
        • chave string

          Chave aplicada para marcar e categorizar este componente.

          O comprimento mínimo é 1, o comprimento máximo é 255.

        • valor string

          Valor definido para a chave aplicada para marcar e categorizar este componente.

          O comprimento mínimo é 1, o comprimento máximo é 255.

      • ldapAuthType string

        Parte do registro do Lightweight Directory Access Protocol (LDAP) que o banco de dados usa para autenticar esse usuário do banco de dados no host LDAP.

        Os valores são NONE, GROUP ou USER. O valor padrão é NONE.

      • oidcAuthType string

        Rótulo legível por humanos que indica se o novo usuário de banco de dados ou grupo se autentica com a autenticação federada OIDC. Para criar um usuário de autenticação federado, especifique o valor de USER neste campo. Para criar um grupo de autenticação federado, especifique o valor de IDP_GROUP neste campo.

        Os valores são NONE, IDP_GROUP ou USER. O valor padrão é NONE.

      • roles array[objeto]

        Lista que fornece os pares de um papel com um banco de dados aplicável.

        Faixa de recursos disponíveis para esse usuário de banco de dados.

        Ocultar atributos de roles Mostrar atributos de funções objeto
        • collectionName string

          Collection na qual essa role se aplica.

        • Nome do Banco de Dados string Obrigatório

          Banco de dados ao qual o usuário recebe privilégios de acesso.

        • roleName string Obrigatório

          Etiqueta legível por humanos que identifica um grupo de privilégios atribuídos a um usuário de banco de dados. Esse valor pode ser uma função integrada ou uma função personalizada.

          Os valores são atlasAdmin, backup, clusterMonitor, dbAdmin, dbAdminAnyDatabase, enableSharding, read, readAnyDatabase, readWrite, readWriteAnyDatabase ou <a custom role name>.

      • scopes array[objeto]

        Lista que contém clusters, data lakes do MongoDB Atlas e instâncias de stream do MongoDB Atlas que esse usuário de banco de dados pode acessar. Se omitido, o MongoDB Cloud concede ao usuário do banco de dados acesso a todos os clusters, todos os data lakes do MongoDB Atlas e todas as instâncias de stream do MongoDB Atlas no projeto.

        Faixa de recursos disponíveis para esse usuário de banco de dados.

        Ocultar atributos de escopo Mostrar atributos de escopos objeto
        • name string Obrigatório

          Rótulo legível por humanos que identifica o cluster ou o MongoDB Atlas Data Lake que esse usuário de banco de dados pode acessar.

          O formato deve corresponder ao seguinte padrão: ^[a-zA-Z0-9][a-zA-Z0-9-]*$.

        • type string Obrigatório

          Categoria de recurso que este usuário de banco de dados pode acessar.

          Os valores são CLUSTER, DATA_LAKE ou STREAM.

      • nome de usuário string Obrigatório

        Rótulo legível por humanos que representa o usuário que se autentica no MongoDB. O formato desse rótulo depende do método de autenticação:

        Método de autenticação Parâmetro necessário Valor do parâmetro formato de nome de usuário
        AWS IAM awsIAMType FUNÇÃO ARN
        AWS IAM awsIAMType USUÁRIO ARN
        x.509 x509Type CLIENTE Nome DistintoRFC 2253
        x.509 x509Type GERENCIADO Nome DistintoRFC 2253
        LDAP ldapAuthType USUÁRIO Nome DistintoRFC 2253
        LDAP ldapAuthType GRUPO Nome DistintoRFC 2253
        OIDC Workforce oidcAuthType IDP_GROUP ID OIDC do Atlas (encontrado nas configurações de federação), seguido por uma "/", seguido pelo nome do grupo IdP
        Carga de trabalho do OIDC oidcAuthType USUÁRIO O ID do provedor de identidade (IdP) do Atlas OIDC (encontrado nas configurações de federação), seguido por uma "/", depois pelo nome de usuário do IdP
        SCRAM-SHA awsIAMType, x509Type, ldapAuthType, oidcAuthType none Texto alfanumérico

        O comprimento máximo é 1024.

      • x509Type string

        Método X.509 que o MongoDB Cloud usa para autenticar o usuário de banco de dados.

        • Para X.509 gerenciado pelo aplicativo, especifique MANAGED.
        • Para X.509 autogerenciado, especifique CUSTOMER.

        Os usuários criados com o método CUSTOMER exigem um Nome Comum (CN) no parâmetro username. Você deve criar usuários autenticados externamente no banco de dados do $external.

        Os valores são NONE, CUSTOMER ou MANAGED. O valor padrão é NONE.

    • contagem total integer(int32)

      Número total de documentos disponíveis. O MongoDB Cloud omite este valor se includeCount estiver definido como false. O número total é uma estimativa e pode não ser exato.

      O valor mínimo é 0.

  • 401 aplicação/json

    Não autorizado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 403 aplicação/json

    Forbidden.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 404 aplicação/json

    Não encontrado.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

  • 500 aplicação/json

    Erro interno do servidor.

    Ocultar atributos de resposta Mostrar atributos de resposta objeto
    • badRequestDetail objeto

      Detalhes da solicitação inválida.

      Ocultar atributo ruimRequestDetail Mostrar atributo ruimRequestDetail objeto
      • Campos array[objeto]

        Descreve todas as violações em uma solicitação do cliente .

        Ocultar atributos de campos Mostrar atributos dos campos objeto
        • Descrição string Obrigatório

          Uma descrição do motivo pelo qual o elemento de solicitação é incorreto.

        • Campo string Obrigatório

          Um caminho que leva a um campo no corpo da solicitação.

    • detalhe string

      Descreve as condições ou os motivos específicos que causam cada tipo de erro.

    • Erro integer(int32) Obrigatório

      O código de status HTTP retornado com este erro.

      Documentação externa
    • Código de erro string Obrigatório

      Código de erro do aplicativo retornado com esse erro.

    • Parâmetros array[objeto]

      Parâmetros usados para fornecer mais informações sobre o erro.

    • Razão string

      Mensagens de erro de aplicativo retornadas com este erro.

GET /api/atlas/v2/groups/{groupId}/databaseUsers
atlas api databaseUsers listGroupDatabaseUsers --help
import (
	"os"
	"context"
	"log"
	sdk "go.mongodb.org/atlas-sdk/v20250219001/admin"
)

func main() {
	ctx := context.Background()
	clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
	clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")

	// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
	client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))

	if err != nil {
		log.Fatalf("Error: %v", err)
	}

	params = &sdk.ListGroupDatabaseUsersApiParams{}
	sdkResp, httpResp, err := client.DatabaseUsersApi.
		ListGroupDatabaseUsersWithParams(ctx, params).
		Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true"
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
  --digest --include \
  --header "Accept: application/vnd.atlas.2025-02-19+json" \
  -X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers?pretty=true"
Exemplos de resposta (200)
{
  "links": [
    {
      "href": "https://cloud.mongodb.com/api/atlas",
      "rel": "self"
    }
  ],
  "results": [
    {
      "awsIAMType": "NONE",
      "databaseName": "admin",
      "deleteAfterDate": "2025-05-04T09:42:00Z",
      "description": "string",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "ldapAuthType": "NONE",
      "links": [
        {
          "href": "https://cloud.mongodb.com/api/atlas",
          "rel": "self"
        }
      ],
      "oidcAuthType": "NONE",
      "roles": [
        {
          "collectionName": "string",
          "databaseName": "string",
          "roleName": "atlasAdmin"
        }
      ],
      "scopes": [
        {
          "name": "string",
          "type": "CLUSTER"
        }
      ],
      "username": "string",
      "x509Type": "NONE"
    }
  ],
  "totalCount": 42
}
Exemplos de resposta (401)
{
  "error": 401,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Unauthorized",
  "errorCode": "NOT_ORG_GROUP_CREATOR"
}
Exemplos de resposta (403)
{
  "error": 403,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Forbidden",
  "errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
Exemplos de resposta (404)
{
  "error": 404,
  "detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
  "reason": "Not Found",
  "errorCode": "RESOURCE_NOT_FOUND"
}
Exemplos de resposta (500)
{
  "error": 500,
  "detail": "(This is just an example, the exception may not be related to this endpoint)",
  "reason": "Internal Server Error",
  "errorCode": "UNEXPECTED_ERROR"
}