문서 메뉴

문서 홈 → MongoDB Cloud Manager

하나의 프로젝트에서 모든 사용자 가져오기

이 페이지의 내용

  • 리소스
  • 요청 매개변수
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 응답 문서
  • results embeddedDocument
  • 요청 예시
  • 응답 예시

참고

그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.

기본 URL: https://cloud.mongodb.com/api/public/v1.0

리소스

GET /groups/{PROJECT-ID}/users

요청 매개변수

요청 경로 매개변수

이름
유형
필요성
설명
프로젝트 ID
문자열
필수 사항
프로젝트의 고유 식별자입니다.

요청 쿼리 매개변수

이름
유형
필요성
설명
flattenTeams
부울
옵션

반환된 목록에 이 프로젝트에서 역할이 할당된 팀에 속한 사용자를 포함할지 여부를 나타내는 플래그입니다. 이 프로젝트에서는 개별 사용자에게 역할을 할당하지 않았을 수 있습니다.

  • 이 플래그를 false 로 설정하면 엔드포인트는 프로젝트에서 역할이 할당된 사용자만 반환합니다.

  • 이 플래그를 true 로 설정하면 엔드포인트는 프로젝트에서 역할이 할당된 사용자 와 프로젝트에서 역할이 할당된 팀의 구성원인 사용자를 모두 반환합니다.

includeOrgUsers
부울
옵션

반환된 목록에 Organization Owner 또는 Organization Read Only 역할을 통해 프로젝트에 대한 암시적 액세스 권한이 있는 사용자를 포함할지 여부를 나타내는 플래그입니다. 이 프로젝트에서는 개별 사용자에게 역할을 할당하지 않았을 수 있습니다.

  • 이 플래그를 false 로 설정하면 엔드포인트는 프로젝트에서 역할이 할당된 사용자만 반환합니다.

  • 이 플래그를 true 로 설정하면 엔드포인트는 프로젝트에서 역할이 할당된 사용자 와 조직 역할을 통해 프로젝트에 암시적으로 액세스할 수 있는 사용자를 모두 반환합니다.

기본값은 false입니다.

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

응답 문서

응답 JSON 문서에는 result 객체 배열, link 객체 배열 및 조회된 result 객체의 총 개수가 포함되어 있습니다.

이름
유형
설명
results
배열
배열에는 results 내장된 문서 섹션에 자세히 설명된 각 항목에 대해 하나의 객체가 포함됩니다.
links
배열
배열에 하위 리소스 및/또는 관련 리소스에 대한 링크가 하나 이상 포함되어 있습니다.URL 간의 관계는 웹 링크 사양에설명되어 있습니다.
totalCount
숫자
결과 집합에 있는 총 항목 수의 정수 개수입니다. 전체 결과 집합이 페이지로 매겨진 경우 results 배열의 객체 수보다 클 수 있습니다.

results embeddedDocument

각 결과 는 사용자 한 명입니다.

이름
유형
설명
이메일 주소
문자열
반환된 MongoDB Atlas 사용자에게 할당된 이메일 주소입니다.
이름
문자열
반환된 MongoDB Atlas 사용자에게 할당된 이름입니다.
id
문자열
반환된 MongoDB Atlas user에게 할당된 고유 식별자입니다.
성
문자열
반환된 MongoDB Atlas user에게 할당된 성입니다.
링크
객체 배열

하위 리소스 및/또는 관련 리소스에 links 대한 하나 이상의 링크입니다. 응답의 모든 배열에는 이라는 링크가 하나 이상 포함되어 self 있습니다.URL 간의 관계는 웹 링크 사양에설명되어 있습니다.

roles
객체 배열
반환된 MongoDB Atlas user에게 할당된 역할입니다.
roles.groupId
문자열
반환된 MongoDB Atlas Atlas user에게 role.roleName 에 제공된 역할이 할당된 프로젝트의 고유 식별자입니다.
roles.orgId
문자열
반환된 MongoDB Atlas 사용자에게 role.roleName 에 제공된 역할이 할당된 조직의 고유 식별자입니다.
roles.roleName
문자열
role.groupId 에 제공된 그룹 또는 role.orgId 에 제공된 조직에서 반환된 MongoDB Atlas 사용자에게 할당된 역할의 표시 이름입니다.
사용자 이름
문자열
반환된 MongoDB Atlas 사용자에게 부여된 MongoDB Atlas 사용자 이름입니다.

요청 예시

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/users?pretty=true&includeOrgUsers=true"

응답 예시

응답 헤더

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

응답 본문

{
  "links" : [ {
    "href" : "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/ users?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "emailAddress" : "joe.bloggs@example.com",
    "firstName" : "Joe",
    "id" : "{USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}",
      "rel" : "self"
    }, {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}/accessList",
      "rel" : "http://mms.mongodb.com/accessList"
    } ],
    "roles" : [ {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }, {
      "groupId" : "{OTHER-PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }
    ...
    ],
    "username" : "joe.bloggs"
  }, {
    "emailAddress" : "jim.bloggs@example.com",
    "firstName" : "Jim",
    "id" : "{OTHER-USER-ID}",
    "lastName" : "Bloggs",
    "links" : [ {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{OTHER-USER-ID}",
      "rel" : "self"
    }, {
      "href" : "https://cloud.mongodb.com/api/public/v1.0/users/{OTHER-USER-ID}/accessList",
      "rel" : "http://mms.mongodb.com/accessList"
    } ],
    "roles" : [ {
      "roleName" : "GLOBAL_READ_ONLY"
    }, {
      "groupId" : "{PROJECT-ID}",
      "roleName" : "GROUP_OWNER"
    }, {
      "orgId" : "{ORGANIZATION-ID}",
      "roleName" : "ORG_READ_ONLY"
    } ],
    "username" : "jim.bloggs"
  } ],
  "totalCount" : 2
}
← 1명의 사용자에 대해 프로젝트 역할 업데이트
1개의 프로젝트에 기존 사용자 추가 →

이 페이지의 내용