지정된 프로젝트와 연관된 대기 중 및 활성 MongoDB Cloud 사용자에 대한 세부 정보를 반환합니다. 이 리소스를 사용하려면, 요청하는 서비스 계정 또는 API 키에 프로젝트 읽기 전용 역할이 있어야 합니다.
참고: 이 리소스는 지원 중단된 1명의 MongoDB Cloud 사용자를 1개의 프로젝트에 참여하도록 초대 엔드포인트를 통해 초대된 사용자에 대한 세부 정보를 보는 데 사용할 수 없습니다.
참고: 보류 중인 사용자와 활성 사용자를 모두 반환하려면 v2-{2025-02- 이상을19} 사용합니다. 더 이상 사용되지 않는 버전을 사용하는 경우 활성 사용자만 반환됩니다.
프로젝트 식별하는 고유한 24-16진수 문자열입니다. 인증된 사용자가 액세스 할 수 있는 모든 프로젝트를 조회 하려면 /groups 엔드포인트를 사용합니다.
참고: 그룹과 프로젝트는 동의어입니다. 그룹 ID는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 리소스 및 해당 엔드포인트는 그룹이라는 용어를 사용합니다.
형식은 ^([a-f0-9]{24})$ 패턴 과 일치해야 합니다.
애플리케이션이 응답을 envelope JSON 객체로 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 결과 목록을 반환하는 엔드포인트는 결과 객체를 엔벨로프로 사용합니다. 애플리케이션은 응답 본문에 상태 매개변수를 추가합니다.
기본값은 false 입니다.
응답이 응답의 총 항목 수(TotalCount)를 반환하는지 여부를 나타내는 플래그입니다.
기본값은 true 입니다.
페이지당 응답이 반환하는 항목 수입니다.
최소값은 1, 최대값은 500입니다. 기본값은 100입니다.
응답이 반환하는 전체 객체의 현재 세트를 표시하는 페이지 번호입니다.
최소값은 1입니다. 기본값은 1입니다.
응답 본문이 프리티프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.
기본값은 false 입니다.
반환된 목록에 이 프로젝트에서 역할이 있는 팀에 속한 사용자를 포함할지 여부를 나타내는 플래그입니다. 이 프로젝트에서는 개별 사용자에게 역할을 할당하지 않았을 수 있습니다. "flattenTeams" : false인 경우 이 리소스는 프로젝트에서 역할이 있는 사용자만 반환합니다. "flattenTeams" : true인 경우 이 리소스는 프로젝트에서 역할이 있는 사용자와 프로젝트에서 역할이 있는 팀에 속한 사용자를 모두 반환합니다.
기본값은 false 입니다.
반환된 목록에 프로젝트에 대한 암시적 액세스 권한이 있는 사용자, 조직 소유자 또는 조직 읽기 전용 역할이 있는 사용자를 포함할지 여부를 나타내는 플래그입니다. 이 프로젝트에서는 개별 사용자에게 역할을 할당하지 않았을 수 있습니다. "includeOrgUsers": false인 경우 이 리소스는 프로젝트에서 역할이 있는 사용자만 반환합니다. "includeOrgUsers": true인 경우 이 리소스는 프로젝트에서 역할이 있는 사용자와 조직 역할을 통해 프로젝트에 암시적으로 액세스할 수 있는 사용자를 모두 반환합니다.
기본값은 false 입니다.
사용자 조직의 멤버십 상태에 따라 반환된 목록을 필터링할지 여부를 나타내는 플래그입니다. 이 매개변수를 제외하면 리소스는 대기 중인 사용자와 활성 사용자를 모두 반환합니다. 사용 중단된 버전에서는 지원되지 않습니다.
사용자를 필터링할 이메일 주소입니다. 사용 중단된 버전에서는 지원되지 않습니다.
atlas api mongoDbCloudUsers listGroupUsers --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20240530001/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.2024-05-30+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.2024-05-30+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"
}