팀에 사용자 추가

이 페이지의 내용

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

Cloud Manager는 더 이상 MongoDB 3 에 대한 자동화, 백업 및 모니터링을 지원하지 않습니다.6 및 4.0 8월 30이후 2024. MongoDB 배포를 업그레이드 하거나 Atlas로 마이그레이션 하세요.

Cloud Manager 에 대한 프로그래밍 방식의 액세스 를 위한 OAuth 2.0 인증 은 Preview 기능 으로 제공됩니다.: 기능 및 해당 설명서는 미리 보기 기간에 언제든지 변경될 수 있습니다. OAuth 2.0 인증 을 사용하려면 Cloud Manager 공개 API 에 대한 요청에 사용할 서비스 계정을 만듭니다.

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

구문

POST /orgs/{ORG-ID}/teams/{TEAM-ID}/users

요청 경로 매개변수

경로 요소	필수/선택 사항	설명
`ORG-ID`	필수 사항입니다.	팀을 연결하려는 조직 의 고유 식별자입니다.
`TEAM-ID`	필수 사항	사용자를 추가하려는 팀 의 이름입니다.

요청 쿼리 매개변수

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

이름

유형

필요성

설명

기본값

pretty

부울

옵션

응답 본문이 프리티 프린트 형식이어야 하는지 여부를 나타내는 플래그입니다.

false

envelope

부울

옵션

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

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

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름	설명
`status`	HTTP 응답 코드
`content`	예상되는 응답 본문

false

요청 본문 매개변수

각 문서는 팀에 추가하려는 한 명의 사용자를 나타내는 문서 배열을 지정합니다. 배열의 각 문서에는 다음 필드가 포함되어야 합니다.

이름	유형	설명
`id`	문자열	팀에 추가하려는 사용자의 고유 ID

응답

응답 문서

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

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

`results` embeddedDocument

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

이름	유형	설명
`country`	문자열	ISO 3166 알파-2 사용자와 관련된 국가 코드입니다.
`emailAddress`	문자열	사용자와 연결된 이메일 주소입니다.
`firstName`	문자열	사용자의 이름입니다.
`id`	문자열	팀의 고유 식별자입니다.
`lastName`	문자열	사용자의 성입니다.
`links`	배열	하위 리소스 및/또는 관련 리소스에 대한 하나 이상의 링크입니다. 응답의 모든 `links` 배열에는 `self` 이라는 링크가 하나 이상 포함되어 있습니다. URL간의 관계는 웹 링크 사양에설명되어 있습니다.
`mobileNumber`	문자열	사용자와 연결된 전화번호입니다.
`roles`	배열	`roles` 배열의 각 객체는 사용자가 관련 `org_id` 에 대해 보유한 MongoDB Atlas 조직 역할을 나타냅니다.
`roles.orgId`	문자열	사용자에게 `roles.roleName` 조직 역할이 할당된 조직의 ID입니다.
`roles.roleName`	문자열	지정된 `roles.orgId` 에 대해 사용자에게 할당된 조직 역할 입니다.
`teamsId`	배열	배열의 각 문자열은 사용자와 연결된 팀입니다.
`username`	문자열	사용자와 연결된 사용자 이름입니다.

요청 예시

curl -u "username:apiKey" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --request POST "https://cloud.mongodb.com/api/public/v1.0/orgs/{ORG-ID}/teams/{TEAM-ID}/users? pretty=true" \
     --data '[{ "id" : "{USER-ID}" }]'

응답 예시

응답 헤더

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/orgs/{ORG-ID}/teams/{TEAM-ID}/users?pretty=true",
      "rel": "self"
     }
 ],
 "results": [
     {
      "country": "US",
      "emailAddress": "JohnDoe@example.com",
      "firstName": "John",
      "id": "{USER-ID}",
      "lastName": "Doe",
      "links": [
          {
              "href": "https://cloud.mongodb.com/api/public/v1.0/users/{USER-ID}",
              "rel": "self"
          }
      ],
      "mobileNumber": "5555550100",
      "roles": [
          {
              "orgId": "{ORG-ID}",
              "roleName": "ORG_MEMBER"
          },
          ...
      ],
      "teamIds": [ "{TEAM-ID}" ],
      "username": "JohnDoe@example.com"
     }
 ],
 "totalCount": 1
}

돌아가기

1개의 프로젝트에서 팀 역할 업데이트

사용자 제거