Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

팀에 할당된 모든 사용자 가져오기

이 페이지의 내용

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

참고

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

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /orgs/{ORG-ID}/teams/{TEAM-ID}/users
경로 요소
필수/선택 사항
설명
ORG-ID
필수 사항
팀 과 연결된 조직 의 고유 식별자입니다.
TEAM-ID
필수 사항
사용자 멤버십을 조회하려는 의 고유 식별자입니다.

다음 쿼리 매개변수는 선택 사항입니다.

이름
유형
필요성
설명
기본값
pageNum
숫자
옵션
결과의 하위 섹션을 반환하는 1부터 시작하는 정수입니다.
1
itemsPerPage
숫자
옵션
페이지당 반환할 항목 수. 최대 500개까지 가능합니다.
100
pretty
부울
옵션
응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타내는 플래그입니다. 형식.
false
envelope
부울
옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope : true를 설정합니다.

결과 목록을 반환하는 엔드포인트의 경우 results 객체는 엔벨로프입니다. Ops Manager가 응답 본문에 status 필드를 추가합니다.

false
backupJobsEnabledOnly
부울
옵션
데이터베이스 백업에 활성화되지 않은 데몬을 응답에서 제외할지 여부를 나타내는 플래그입니다. backupJobsEnabled 플래그가 false 로 설정된 daemon 구성을 포함하려면 이 값을 false 로 설정합니다.
true

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

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

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

result 배열의 각 요소는 팀에 할당된 사용자 한 명입니다.

이름
유형
설명
emailAddress
문자열
사용자와 연결된 이메일 주소입니다.
firstName
문자열
사용자의 이름입니다.
id
문자열
팀의 고유 식별자입니다.
lastName
문자열
사용자의 성입니다.
links
객체 배열

하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. URL 간의 관계 유형은 웹 링크 사양 에 설명되어 있습니다. .

roles
배열
roles 배열의 각 객체는 연결된 orgId 또는 groupId 에 대해 사용자가 가진 MongoDB Atlas 조직 역할을 나타냅니다.
roles.orgId
문자열
roles.groupId
문자열
사용자에게 프로젝트 역할 이 할당된 프로젝트의 ID입니다.roles.roleName
roles.roleName
문자열
지정된 roles.orgId 또는 roles.groupId 에 대해 사용자에게 할당된 조직 역할 입니다.
teamsIds
배열
사용자가 속한 각 팀의 string ID 배열입니다.
username
문자열
사용자와 연결된 사용자 이름입니다.
curl --user "{username:apiKey}" --digest -i \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pageNum=1&itemsPerPage=100",
"rel": "self"
}
],
"results": [
{
"emailAddress": "CloudUser@example.com",
"firstName": "Cloud",
"id": "{USER-ID}",
"lastName": "User",
"links": [
{
"href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/users/{USER-ID}",
"rel": "self"
}
],
"roles": [
{
"groupId": "{PROJECT-ID}",
"roleName": "GROUP_OWNER"
},
{
"orgId": "{ORG-ID}",
"roleName": "ORG_OWNER"
}
],
"teamIds": [
"{TEAM-ID}"
],
"username": "CloudUser@example.com"
}
],
"totalCount": 1
}

돌아가기

이름으로 1개의 팀 가져오기