Retornar todos os usuários do MongoDB Cloud em um projeto
Obsoleto(a)
Retorna detalhes sobre os usuários pendentes e ativos do MongoDB Cloud associados 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.
Nota: este recurso não pode ser usado para visualizar detalhes sobre usuários convidados por meio do ponto de extremidade obsoleto Convidar um usuário do MongoDB Cloud para participar de um projeto.
Observação : para retornar usuários pendentes e ativos, use v2-{2025-02-19} ou posterior. Se estiver usando uma versão obsoleta, apenas os usuários ativos serão retornados.
parâmetros de caminho
-
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
-
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. -
Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
O valor padrão é
true. -
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. -
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. -
Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint.
O valor padrão é
false.Prettyprint -
Sinalizador que indica se a lista retornada deve incluir usuários que pertencem a uma equipe com uma função neste projeto. Talvez você não tenha atribuído uma função aos usuários individuais neste projeto. Se
"flattenTeams" : false, este recurso retornará apenas usuários com uma função no projeto. Se"flattenTeams" : true, este recurso retornará tanto os usuários com funções no projeto quanto os usuários que pertencem a equipes com funções no projeto.O valor padrão é
false. -
Sinalizador que indica se a lista retornada deve incluir usuários com acesso implícito ao projeto e às funções "Proprietário da organização" ou "Somente leitura da organização". Talvez você não tenha atribuído uma função aos usuários individuais neste projeto. Se
"includeOrgUsers": false, este recurso retornará apenas usuários com uma função no projeto. Se"includeOrgUsers": true, este recurso retornará usuários com funções no projeto e usuários com acesso implícito ao projeto por meio de sua função da organização.O valor padrão é
false. -
Sinalizador que indica se a lista retornada deve ser filtrada pelo status de associação à organização do usuário. Se você excluir este parâmetro, o recurso retornará usuários pendentes e ativos. Não é suportado em versões descontinuadas.
-
Endereço de e-mail para filtrar usuários. Não é suportado em versões descontinuadas.
atlas api mongoDbCloudUsers listGroupUsers --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20231115001/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.ListGroupUsersApiParams{}
sdkResp, httpResp, err := client.MongoDBCloudUsersApi.
ListGroupUsersWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-11-15+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-11-15+json" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/users?pretty=true"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"country": "string",
"createdAt": "2025-05-04T09:42:00Z",
"emailAddress": "hello@example.com",
"firstName": "string",
"id": "32b6e34b3d91647abb20e7b8",
"lastAuth": "2025-05-04T09:42:00Z",
"lastName": "string",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mobileNumber": "string",
"password": "string",
"roles": [
{
"groupId": "32b6e34b3d91647abb20e7b8",
"orgId": "32b6e34b3d91647abb20e7b8",
"roleName": "ORG_MEMBER"
}
],
"teamIds": [
"32b6e34b3d91647abb20e7b8"
],
"username": "hello@example.com"
}
],
"totalCount": 42
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"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"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}