모든 조직 사용자 가져오기
이 페이지의 내용
- Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.
- 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할서비스 계정을 만듭니다.
기본 URL: https://cloud.mongodb.com/api/public/v1.0
구문
GET /orgs/{ORG-ID}/users
요청 경로 매개변수
Parameter | 필수/선택 사항 | 설명 |
|---|---|---|
ORG-ID | 필수 사항입니다. | 사용자 정보를 조회 하려는 조직 의 고유 식별자입니다. |
요청 쿼리 매개변수
필드 | 필수/선택 사항 | 설명 |
|---|---|---|
pageNum | 선택 사항. | 반환할 페이지입니다. 기본값은 |
itemsPerPage | 선택 사항. | 페이지당 반환할 항목 수. 최대 500개까지 가능합니다. 기본값은 |
envelope | 선택 사항. | 응답을 엔벨로프에 래핑할지 여부를 지정하는 부울입니다. 기본값은 |
pretty | 옵션 | '예쁘게 인쇄된' JSON document 를 반환할지 여부를 지정하는 부울입니다. 기본값은 |
응답 요소
쿼리 요소 envelope 를 true 로 설정하면 응답이 content 객체에 의해 래핑됩니다.
HTTP 응답은 다음 객체를 포함하는 JSON document를 반환합니다.
results
각각 한 명의 조직 사용자를 나타내는 문서 배열입니다.
이름 | 설명 | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
country | 사용자가 거주하는 국가입니다. | ||||||||||||||
emailAddress | 사용자의 이메일 주소입니다. | ||||||||||||||
firstName | 사용자의 이름입니다. | ||||||||||||||
lastName | 사용자가 속한 Cloud Manager 프로젝트의 ID입니다. | ||||||||||||||
id | 사용자의 ID입니다. | ||||||||||||||
links | 하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. | ||||||||||||||
mobileNumber | 사용자의 휴대폰 번호입니다. | ||||||||||||||
username | MongoDB에 인증하기 위한 사용자 이름입니다. | ||||||||||||||
roles | 조직 내 및 사용자가 속한 각 프로젝트에 대한 사용자 역할의 배열입니다. | ||||||||||||||
roles.{ENTITY-ID} | {ENTITY-ID} 는 이 역할이 적용되는 조직 또는 프로젝트를 나타냅니다. 가능한 값은 orgId 또는 groupId 입니다. | ||||||||||||||
roles.roleName | 역할 의 이름입니다.
| ||||||||||||||
teamIds | 조직의 팀 ID 배열입니다. |
links
하나 이상의 하위 리소스 및/또는 관련 리소스(예:목록 페이지 매김 )에 대한 링크 를 나타내는 문서 배열입니다. 자세한 내용은 연결 을 참조하세요.
totalCount
결과 세트의 총 항목 수입니다. 전체 결과 집합이 페이지로 매겨진 경우 이 값은 results 배열의 객체 수보다 클 수 있습니다.
요청 예시
요청
curl -i -u "username:apiKey" --digest "https://cloud.mongodb.com/api/public/v1.0/orgs/59db8d1d87d9d6420df0613f/users?pretty=true"
응답
{ "links" : [ ... ], "results" : [ { "country": "US", "emailAddress": "someone@example.com", "firstName": "John", "id": "59db8d1d87d9d6420df0613a", "lastName": "Smith", "links": [ ... ], "mobileNumber": "123-456-7890", "roles": [{ "groupId": "59ea02e087d9d636b587a967", "roleName": "GROUP_OWNER" }, { "groupId": "59db8d1d87d9d6420df70902", "roleName": "GROUP_OWNER" }, { "orgId": "59db8d1d87d9d6420df0613f", "roleName": "ORG_OWNER" }], "teamIds" : [ "5aeeed020bd6ef9d00033291", "5ac2aeadcabceef96172be31" ], "username": "someone@example.com" }, ... ], "totalCount" : 2 }