通过名称获取用户

在此页面上

资源

请求路径参数
请求查询参数
请求正文参数
响应
请求示例
响应示例
响应标头
响应体

Ops Manager v 6 。 0将于2025 1 月停产。尽快升级到更高的 Ops Manager 版本。

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

您可以随时找回自己的用户帐户。否则，您必须是全局用户，或者您必须在您和要检索的用户之间的至少一个共同项目中具有Project User Admin角色。

您无法使用此端点返回 API 密钥的信息。请求获取一个 API 密钥端点以获取此信息。

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

资源

GET /users/byName/{USER-NAME}

请求路径参数

范围	类型	说明
USER-NAME	字符串	（必需。）要检索的 MongoDB 用户的用户名。

请求查询参数

以下查询参数为可选参数：

名称

类型

必要性

说明

默认

pretty

布尔

Optional

指示响应正文是否应采用美观文本的标志格式。

false

envelope

布尔

Optional

指示是否将响应包装在信封中的标志。

某些 API 客户端无法访问 HTTP 响应标头或状态代码。要解决这个问题，可在查询中设置 envelope=true。

对于返回一个结果的端点，响应体包括：

名称	说明
状态	HTTP 响应代码
envelope	预期响应正文

false

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应

该HTTP 文档包含以下每个元素：

名称

类型

说明

邮箱

字符串

Ops Manager 用户的电子邮件地址。

名

字符串

Ops Manager 用户的名字。

字符串

Ops Manager 用户的唯一标识符。

姓

字符串

Ops Manager 用户的姓氏。

链接

对象数组

相关子资源链接。响应中的所有links 数组至少包含一个名为 self 的链接。 URL 之间的关系在 Web 链接规范中进行了解释。

mobileNumber

字符串

Ops Manager 用户的手机号码。

角色

对象数组

角色分配。

roles.groupId

字符串

用户具有指定角色的项目的唯一标识符。

对于“全局”角色（名称以GLOBAL_开头的角色），没有groupId ，因为这些角色不与项目绑定。

roles.orgId

字符串

用户在其中具有指定角色的组织的唯一标识符。

roles.roleName

字符串

角色的名称。值为：

值	说明
`ORG_MEMBER`	`Organization Member`
`ORG_READ_ONLY`	`Organization Read Only`
`ORG_GROUP_CREATOR`	`Organization Project Creator`
`ORG_OWNER`	`Organization Owner`
`GROUP_AUTOMATION_ADMIN`	`Project Automation Admin`
`GROUP_BACKUP_ADMIN`	`Project Backup Admin`
`GROUP_MONITORING_ADMIN`	`Project Monitoring Admin`
`GROUP_OWNER`	`Project Owner`
`GROUP_READ_ONLY`	`Project Read Only`
`GROUP_USER_ADMIN`	`Project User Admin`
`GROUP_DATA_ACCESS_ADMIN`	`Project Data Access Admin`
`GROUP_DATA_ACCESS_READ_ONLY`	`Project Data Access Read Only`
`GROUP_DATA_ACCESS_READ_WRITE`	`Project Data Access Read/Write`
`GLOBAL_AUTOMATION_ADMIN`	`Global Automation Admin`
`GLOBAL_BACKUP_ADMIN`	`Global Backup Admin`
`GLOBAL_MONITORING_ADMIN`	`Global Monitoring Admin`
`GLOBAL_OWNER`	`Global Owner`
`GLOBAL_READ_ONLY`	`Global Read Only`
`GLOBAL_USER_ADMIN`	`Global User Admin`

用户名

字符串

Ops Manager 用户的用户名。

请求示例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://<ops-manager-host>/api/public/v1.0/users/byName/jane"

响应示例

响应标头

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}

响应体

{
  "emailAddress" : "jane@qa.example.com",
  "firstName" : "Jane",
  "id" : "533dc19ce4b00835ff81e2eb",
  "lastName" : "D'oh",
  "roles" : [ {
    "groupId" : "{PROJECT-ID}",
    "roleName" : "GROUP_USER_ADMIN"
  },{
    "orgId" : "55555bbe3bd5253aea2d9b16",
    "roleName" : "ORG_MEMBER"
  } ],
  "links" : [],
  "username": "jane"
}

← 通过 ID 获取用户

创建一个用户 →