更新单个用户的角色
注意
注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
在组织或项目中添加、更新或删除用户的角色。 默认，有效负载中的任何新的非全局组织和项目角色都会先向用户发送加入组织或项目的邀请。 仅当设立 mms.user.bypassInviteForExistingUsers设置为true时，才能将用户直接添加到组织或项目中。
Resource
基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
PATCH /users/{USER-ID}
所需角色
您必须具有适当的所有者角色才能使用此 API端点。
等级 | 所需角色 |
|---|---|
组织 | |
项目 |
重要
您可以随时更新自己的用户帐户。
如果您拥有一个组织或项目，则可以为具有该组织或项目成员资格的任何用户更新用户角色。 您不能修改任何其他用户配置文件信息。
请求路径参数
名称 | 类型 | 必要性 | 说明 |
|---|---|---|---|
USER-ID | 字符串 | 必需 | 要检索的用户的唯一标识符。要检索用户的 USER-ID，请参阅获取一个项目中的所有用户。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
pretty | 布尔 | Optional | 指示响应正文是否应采用 Prettyprint 的标志 格式。 | false | ||||||
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。 对于返回一个结果的端点，响应体包括：
| false |
请求正文参数
名称 | 类型 | 必要性 | 说明 | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
roles | 对象数组 | 必需 | 分配给 Ops Manager 用户的角色。 | ||||||||||||||||||||||||||||||||||||||||
roles.orgId | 字符串 | Optional | Ops Manager 用户在其中具有指定角色的组织的唯一标识符。 | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | 字符串 | Optional | Ops Manager 用户在其中具有指定角色的项目的唯一标识符。 以 | ||||||||||||||||||||||||||||||||||||||||
roles.roleName | 字符串 | Optional | 角色的名称。接受的值为：
|
响应
JSON文档包含以下每个元素：
Name | 类型 | 说明 | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
emailAddress | 字符串 | Ops Manager 用户的电子邮件地址。 | ||||||||||||||||||||||||||||||||||||||||
firstName | 字符串 | Ops Manager 用户的名字。 | ||||||||||||||||||||||||||||||||||||||||
id | 字符串 | Ops Manager 用户的唯一标识符。 | ||||||||||||||||||||||||||||||||||||||||
lastName | 字符串 | Ops Manager 用户的姓氏。 | ||||||||||||||||||||||||||||||||||||||||
links | 对象数组 | 相关子资源链接。 响应中的所有 links数组至少包含一个名为 self 的链接。 URL 之间的关系在 Web 链接规范中进行了解释。 | ||||||||||||||||||||||||||||||||||||||||
mobileNumber | 字符串 | Ops Manager 用户的手机号码。 | ||||||||||||||||||||||||||||||||||||||||
roles | 空数组 | 分配给 Ops Manager 用户的角色。 | ||||||||||||||||||||||||||||||||||||||||
roles.groupId | 字符串 | 用户具有指定角色的项目的唯一标识符。 以 | ||||||||||||||||||||||||||||||||||||||||
roles.orgId | 字符串 | 用户在其中具有指定角色的组织的唯一标识符。 | ||||||||||||||||||||||||||||||||||||||||
roles.roleName | 字符串 | 角色的名称。接受的值为：
| ||||||||||||||||||||||||||||||||||||||||
username | 字符串 | 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 }