Devuelve detalles sobre los usuarios de MongoDB Cloud pendientes y activos asociados al proyecto especificado. Para usar este recurso, la cuenta de servicio o la clave API solicitantes deben tener el rol de solo lectura del proyecto.
Nota: Este recurso no se puede usar para ver detalles sobre los usuarios invitados a través del punto final obsoleto Invitar a un usuario de MongoDB Cloud a unirse a un proyecto.
Nota: Para devolver tanto los usuarios pendientes como los activos, utilice la versión v2-{2025-02-19} o posterior. Si utiliza una versión obsoleta, solo se devolverán los usuarios activos. Versiones obsoletas: v2-{2023-01-01}
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$.
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false. -
Bandera que indica si la respuesta devuelve el número total de elementos (
totalCount) en la respuesta.El valor predeterminado es
true. -
Número de elementos que la respuesta devuelve por página.
El valor mínimo es
1, el valor máximo es500. El valor predeterminado es100. -
Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.
El valor mínimo es
1. El valor por defecto es1. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado es
false.Impresión bonita -
Marca que indica si la lista devuelta debe incluir usuarios que pertenecen a un equipo con un rol en este proyecto. Es posible que no haya asignado un rol a los usuarios individuales en este proyecto. Si
"flattenTeams" : false, este recurso devuelve solo usuarios con un rol en el proyecto. Si"flattenTeams" : true, este recurso devuelve tanto usuarios con roles en el proyecto como usuarios que pertenecen a equipos con roles en el proyecto.El valor predeterminado es
false. -
Marca que indica si la lista devuelta debe incluir usuarios con acceso implícito al proyecto, el rol de propietario de la organización o el rol de solo lectura de la organización. Es posible que no haya asignado un rol a los usuarios individuales en este proyecto. Si
"includeOrgUsers": false, este recurso devuelve solo los usuarios con un rol en el proyecto. Si"includeOrgUsers": true, este recurso devuelve tanto los usuarios con roles en el proyecto como los usuarios con acceso implícito al proyecto a través de su rol de organización.El valor predeterminado es
false. -
Indicador que indica si se debe filtrar la lista devuelta por el estado de pertenencia a la organización de los usuarios. Si se excluye este parámetro, este recurso devuelve tanto los usuarios pendientes como los activos. No compatible con versiones obsoletas.
-
Dirección de correo electrónico para filtrar usuarios. No compatible con versiones obsoletas.
atlas api mongoDbCloudUsers listGroupUsers --helpimport (
"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.ListGroupUsersApiParams{}
sdkResp, httpResp, err := client.MongoDBCloudUsersApi.
ListGroupUsersWithParams(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}/users?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}/users?pretty=true"{
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"results": [
{
"id": "32b6e34b3d91647abb20e7b8",
"orgMembershipStatus": "PENDING",
"roles": [
"string"
],
"username": "hello@example.com",
"invitationCreatedAt": "2026-05-04T09:42:00Z",
"invitationExpiresAt": "2026-05-04T09:42:00Z",
"inviterUsername": "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"
}