Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
Cloud Manager 관리 API 리소스
/
프로젝트 및 사용자
/
사용자

사용자 한 명 만들기

이 페이지의 내용

  • Resource
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 요청 예시
  • 응답 예시
  • 응답 헤더
  • 응답 본문

참고

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

새 사용자를 만듭니다. 페이로드에 포함된 전역이 아닌 조직 및 프로젝트 역할은 기본적으로 사용자에게 조직 또는 프로젝트에 대한 초대를 먼저 보냅니다.

Resource

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

POST /users

요청 경로 매개변수

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

요청 쿼리 매개변수

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

이름
유형
필요성
설명
기본값
pretty
부울
옵션
응답 본문을 프리티프린트 에 포함해야 하는지 여부를 나타내는 플래그입니다. 형식.
false
envelope
부울
옵션

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

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

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

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

요청 본문 매개변수

모든 필드는 필수로 입력해야 합니다.

이름
유형
설명
사용자 이름
문자열
Cloud Manager 사용자의 사용자 이름입니다. 유효한 이메일 주소여야 합니다.
비밀번호
문자열

Cloud Manager 사용자의 비밀번호입니다.

이 필드는 서버에서 반환된 엔터티에 포함 되지 않습니다 . 새 사용자를 만들 때 엔터티 본문에서만 보낼 수 있습니다.

이메일 주소
문자열
Cloud Manager 사용자의 이메일 주소입니다.
mobileNumber
문자열
Cloud Manager 사용자의 휴대폰 번호입니다.
이름
문자열
Cloud Manager 사용자의 이름입니다.
성
문자열
Cloud Manager 사용자의 성입니다.
국가
문자열
Cloud Manager 사용자의 기반이 되는 기본 국가입니다. 두 글자로 된 ISO 3661- 와1 일치해야 합니다. 국가 코드.
roles
객체 배열
Cloud Manager 사용자의 역할 할당입니다.
roles.orgId
문자열
Cloud Manager 사용자가 지정된 역할을 가진 조직의 고유 식별자입니다.
roles.groupId
문자열
Cloud Manager 사용자가 지정된 역할을 가진 그룹의 고유 식별자입니다.
roles.roleName
문자열

역할의 이름입니다. 허용되는 값은 다음과 같습니다.

값
설명
ORG_MEMBER
Organization Member
ORG_READ_ONLY
ORG_BILLING_ADMIN
ORG_GROUP_CREATOR
ORG_OWNER
GROUP_ATLAS_ADMIN
Project Admin (Atlas)
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_MONITORING_ADMIN
GROUP_OWNER
GROUP_READ_ONLY
GROUP_USER_ADMIN
GROUP_BILLING_ADMIN
프로젝트 청구 관리자
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE

응답

JSON 문서에는 다음과 같은 각 요소가 포함되어 있습니다.

Name
유형
설명
emailAddress
문자열
Cloud Manager 사용자의 이메일 주소입니다.
firstName
문자열
Cloud Manager 사용자의 이름입니다.
id
문자열
Cloud Manager 사용자의 고유 식별자입니다.
lastName
문자열
Cloud Manager 사용자의 성입니다.
links
객체 배열
관련 하위 리소스에 대한 링크입니다. 응답의 모든 links 배열에는 자체 링크가 하나 이상 포함되어 있습니다. URL 간의 관계는 웹 링크 사양에 설명되어 있습니다.
mobileNumber
문자열
Cloud Manager 사용자의 휴대폰 번호입니다.
roles
빈 배열
Cloud Manager 사용자에게 할당된 역할입니다.
roles
.groupId
문자열
사용자가 지정된 역할을 갖고 있는 프로젝트의 고유 식별자입니다.
roles
.orgId
문자열
사용자가 지정된 역할을 갖고 있는 조직의 고유 식별자입니다.
roles
.roleName
문자열

역할의 이름입니다. 허용되는 값은 다음과 같습니다.

참고

users 리소스는 사용자가 Cloud Manager와 MongoDB Atlas 모두에서 가지고 있는 모든 역할을 반환합니다.

값
설명
ORG_MEMBER
ORG_READ_ONLY
ORG_BILLING_ADMIN
Organization Billing Admin
ORG_GROUP_CREATOR
ORG_OWNER
GROUP_AUTOMATION_ADMIN
GROUP_BACKUP_ADMIN
GROUP_MONITORING_ADMIN
GROUP_OWNER
GROUP_READ_ONLY
GROUP_USER_ADMIN
GROUP_DATA_ACCESS_ADMIN
GROUP_DATA_ACCESS_READ_ONLY
GROUP_DATA_ACCESS_READ_WRITE
username
문자열
Cloud Manager 사용자의 사용자 이름입니다.

요청 예시

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request POST "https://cloud.mongodb.com/api/public/v1.0/users" \
6     --data '
7       {
8         "username": "jane.doe@mongodb.com",
9         "emailAddress": "jane.doe@mongodb.com",
10         "firstName": "Jane",
11         "lastName": "Doe",
12         "password": "M0ng0D8!:)",
13         "country" : "US",
14         "roles": [{
15           "groupId": "533daa30879bb2da07807696",
16           "roleName": "GROUP_USER_ADMIN"
17         },{
18           "orgId" : "55555bbe3bd5253aea2d9b16",
19           "roleName" : "ORG_MEMBER"
20         }]
21       }'

응답 예시

응답 헤더

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 201 Created
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}

응답 본문

{
  "id" : "533dc19ce4b00835ff81e2eb",
  "username" : "jane.doe@mongodb.com",
  "emailAddress" : "jane.doe@mongodb.com",
  "firstName" : "Jane",
  "lastName" : "Doe",
  "roles" : [],
  "links" : []
}

돌아가기

이름으로 사용자 가져오기