getUser()

名称

getUser - 获取用户的信息

语法

db.getUser(<username>, [options])

类别

Sdb

描述

该函数用于获取指定用户的信息

参数

• username （ string，必填 ） 指定用户

• options （ object，选填 ） 额外参数

  • ShowPrivileges （ boolean ） 展示用户的权限，默认值为 false

返回值

函数执行成功时，将返回一个 BSONObj 类型的对象。通过该对象获取用户的详细信息。

函数执行失败时，将抛异常并输出错误信息。

错误

常见异常如下：

当异常抛出时，可以通过 getLastErrMsg() 获取错误信息或通过 getLastError() 获取错误码。更多错误处理可以参考常见错误处理指南。

版本

v5.8 及以上版本

示例

• 在集群中获取名为 myuser 的角色，不开启 ShowPrivileges 选项

  > db.getUser("myuser")
  {
    "User": "myuser",
    "Roles": [
        "_foo.read"
    ],
    "Options": {}
  }

• 在集群中获取名为 myuser 的角色，开启 ShowPrivileges 选项

  > db.getUser("myuser",{ShowPrivileges:true})
    {
        "User": "myuser",
        "Roles": [
            "_foo.read"
        ],
        "Options": {},
        "InheritedRoles": [
            "_foo.read"
        ],
        "InheritedPrivileges": [
            {
            "Resource": {
                "cs": "foo",
                "cl": ""
            },
            "Actions": [
                "find",
                "getDetail"
            ]
            }
        ]
    }