참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID가 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
새 사용자를 만듭니다. 페이로드에 포함된 전역이 아닌 조직 및 프로젝트 역할은 기본적으로 사용자에게 조직 또는 프로젝트에 대한 초대를 먼저 보냅니다.
Resource
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
POST /users요청 경로 매개변수
이 엔드포인트는 HTTP 요청 경로 매개변수를 사용하지 않습니다.
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
이름 | 유형 | 필요성 | 설명 | 기본값 |
|---|---|---|---|---|
pretty | 부울 | 옵션 | 응답 본문이 pretty-print 형식인지 여부를 나타내는 플래그입니다. |
|
envelope | 부울 | 옵션 | 응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다. 일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다. 하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.
|
|
요청 본문 매개변수
모든 필드는 필수로 입력해야 합니다.
이름 | 유형 | 설명 |
|---|---|---|
사용자 이름 | 문자열 | Ops Manager 사용자의 사용자 이름입니다.
자세한 내용은 |
비밀번호 | 문자열 | Ops Manager 사용자의 비밀번호입니다. 이 필드 는 서버 에서 반환된 엔터티에 포함 되지 않습니다 . 새 사용자를 만들 때 엔터티 본문에서만 보낼 수 있습니다. |
이메일 주소 | 문자열 | Ops Manager 사용자의 이메일 주소입니다. |
mobileNumber | 문자열 | Ops Manager 사용자의 휴대폰 번호입니다. |
이름 | 문자열 | Ops Manager 사용자의 이름입니다. |
성 | 문자열 | Ops Manager 사용자의 성입니다. |
roles | 객체 배열 | Ops Manager 사용자의 역할 할당입니다. |
roles.orgId | 문자열 | Ops Manager 사용자가 지정된 역할을 가진 조직의 고유 식별자입니다. |
roles.groupId | 문자열 | Ops Manager 사용자가 지정된 역할을 가진 그룹의 고유 식별자입니다. "글로벌" 역할( 이름이 |
roles.roleName | 문자열 | 역할의 이름입니다. 허용되는 값은 다음과 같습니다.
|
응답
JSON 문서 에는 다음과 같은 각 요소가 포함되어 있습니다.
Name | 유형 | 설명 |
|---|---|---|
| 문자열 | Ops Manager 사용자의 이메일 주소입니다. |
| 문자열 | Ops Manager 사용자의 이름입니다. |
| 문자열 | Ops Manager 사용자의 고유 식별자입니다. |
| 문자열 | Ops Manager 사용자의 성입니다. |
| 객체 배열 | 관련 하위 리소스에 대한 링크입니다. 응답의 모든 |
| 문자열 | Ops Manager 사용자의 휴대폰 번호입니다. |
| 빈 배열 | Ops Manager 사용자에게 할당된 역할입니다. |
| 문자열 | 사용자가 지정된 역할을 갖고 있는 프로젝트의 고유 식별자입니다.
|
| 문자열 | 사용자가 지정된 역할을 갖고 있는 조직의 고유 식별자입니다. |
| 문자열 | 역할의 이름입니다. 허용되는 값은 다음과 같습니다.
|
| 문자열 | Ops Manager 사용자의 사용자 이름입니다. |
요청 예시
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --header "Content-Type: application/json" \ --include \ --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/users" \ --data ' { "username": "jane.doe@mongodb.com", "emailAddress": "jane.doe@mongodb.com", "firstName": "Jane", "lastName": "Doe", "password": "M0ng0D8!:)", "roles": [{ "groupId": "533daa30879bb2da07807696", "roleName": "GROUP_USER_ADMIN" },{ "orgId" : "55555bbe3bd5253aea2d9b16", "roleName" : "ORG_MEMBER" }] }'응답 예시
응답 헤더
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-aliveHTTP/1.1 201 CreatedVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-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" : []}