한 명의 사용자에 대해 역할 업데이트
참고
그룹과 프로젝트는 동의어입니다. {PROJECT-ID}
는 프로젝트 ID와 동일합니다. 기존 그룹의 경우, 그룹/프로젝트 ID는 동일하게 유지됩니다. 이 페이지에서는 설명에 대해 얘기할 때 더욱 친숙한 용어 그룹을 사용합니다. 엔드포인트는 문서에 명시된 대로 유지됩니다.
조직 또는 프로젝트 내에서 사용자의 역할을 추가, 업데이트 또는 제거 합니다. 기본값 페이로드에 있는 새로운 비전역 조직 및 프로젝트 역할은 먼저 사용자에게 조직 또는 프로젝트 에 대한 초대를 보냅니다. mms.user.bypassInviteForExistingUsers
설정을 true
로 설정하다 한 경우에만 조직 또는 프로젝트 에 사용자를 직접 추가할 수 있습니다.
Resource
기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /users/{USER-ID}
필수 역할
이 API 엔드포인트를 사용하려면 적절한 소유자 역할이 있어야 합니다.
수준 | 필요한 역할 |
---|---|
조직 | |
프로젝트 |
중요
언제든지 자신의 사용자 계정을 업데이트할 수 있습니다.
조직 또는 프로젝트를 소유한 경우 해당 조직 또는 프로젝트의 멤버십이 있는 모든 사용자의 사용자 역할 을 업데이트할 수 있습니다. 다른 사용자 프로필 정보는 수정할 수 없습니다.
요청 경로 매개변수
이름 | 유형 | 필요성 | 설명 |
---|---|---|---|
| 문자열 | 필수 사항 | 조회하려는 사용자의 고유 식별자입니다. 사용자에 대한 |
요청 쿼리 매개변수
다음 쿼리 매개변수는 선택 사항입니다.
요청 본문 매개변수
이름 | 유형 | 필요성 | 설명 | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 객체 배열 | 필수 사항 | 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 사용자에게 할당된 역할입니다. | ||||||||||||||||||||||||||||||||||||||||
roles .groupId | 문자열 | 사용자가 지정된 역할을 갖고 있는 프로젝트의 고유 식별자입니다.
| ||||||||||||||||||||||||||||||||||||||||
roles .orgId | 문자열 | 사용자가 지정된 역할을 갖고 있는 조직의 고유 식별자입니다. | ||||||||||||||||||||||||||||||||||||||||
roles .roleName | 문자열 | 역할의 이름입니다. 허용되는 값은 다음과 같습니다.
| ||||||||||||||||||||||||||||||||||||||||
| 문자열 | Ops Manager 사용자의 사용자 이름입니다. |
요청 예시
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}" \ 6 --data ' 7 { 8 "roles": [{ 9 "groupId": "{GROUP-ID}", 10 "roleName": "{ROLE}" 11 }] 12 }'
응답 예시
응답 헤더
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
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}
응답 본문
1 { 2 "id": "{USER-ID}", 3 "username": "jane", 4 "emailAddress": "jane@qa.example.com", 5 "firstName": "Jane", 6 "lastName": "D'oh", 7 "links": [{ 8 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}", 9 "rel": "self" 10 }, 11 { 12 "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/users/{USER-ID}/accessList", 13 "rel": "http://mms.mongodb.com/accessList" 14 }], 15 "roles": [{ 16 "orgId": "{ORG-ID}", 17 "roleName": "ORG_MEMBER" 18 },{ 19 "groupId": "{PROJECT-ID}", 20 "roleName": "GROUP_READ_ONLY" 21 }], 22 "teamIds": [] 23 }