db.getUser() (mongosh method方法)

Definition定义

db.getUser(username, args)

Returns user information for a specified user. Run this method on the user's database. 返回指定用户的用户信息。在用户的数据库上运行此方法。If the user doesn't exist in the database, db.getUser() returns null.如果数据库中不存在该用户，db.getUser()将返回null。

The db.getUser() method has the following parameters:db.getUser()方法有以下参数：

db.getUser( "<username>", {
   showCredentials: <Boolean>,
   showCustomData: <Boolean>,
   showPrivileges: <Boolean>,
   showAuthenticationRestrictions: <Boolean>,
   filter: <document>
} )

Parameter参数	Type类型	Description描述
username	string字符串	The name of the user for which to retrieve information.要检索其信息的用户的名称。
args	document文档	Optional. 可选。A document specifying additional arguments.指定其他参数的文档。

The args document supports the following fields:args文档支持以下字段：

Field字段	Type类型	Description描述
showCredentials	boolean布尔值	Optional. 可选。Set to true to display the user's password hash.设置为true以显示用户的密码哈希值。 By default, this field is false.默认情况下，此字段为false。
showCustomData	boolean布尔值	Optional. 可选。Set to false to omit the user's customData from the output.设置为false可从输出中省略用户的customData。 By default, this field is true.默认情况下，此字段为true。 New in version 5.2.在版本5.2中新增。
showPrivileges	boolean布尔值	Optional. 可选。Set to true to show the user's full set of privileges, including expanded information for the inherited roles.设置为true可显示用户的全部权限，包括继承角色的扩展信息。 By default, this field is false.默认情况下，此字段为false。 If viewing all users, you cannot specify this field.如果查看所有用户，则无法指定此字段。
showAuthenticationRestrictions	boolean布尔值	Optional. 可选。Set to true to show the user's authentication restrictions.设置为true以显示用户的身份验证限制。 By default, this field is false.默认情况下，此字段为false。 If viewing all users, you cannot specify this field.如果查看所有用户，则无法指定此字段。
filter	document文档	Optional. 可选。A document that specifies $match stage conditions to return information for users that match the filter conditions.一个文档，指定$match阶段条件，为符合筛选条件的用户返回信息。

db.getUser() wraps the usersInfo: <username> command.包装usersInfo: <username>命令。

For details on output, see usersInfo.有关输出的详细信息，请参阅usersInfo。

Compatibility兼容性

This method is available in deployments hosted in the following environments:此方法在以下环境中托管的部署中可用：

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB：MongoDB的基于订阅的自我管理版本
• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB：MongoDB的源代码可用、免费使用和自我管理版本

Required Access所需访问权限

To view another user's information, you must have the viewUser action on the other user's database.要查看其他用户的信息，您必须对其他用户的数据库执行viewUser操作。

Users can view their own information.用户可以查看自己的信息。

Examples示例

The following operations return information about an example appClient user in an accounts database:以下操作返回accounts数据库中示例appClient用户的信息：

use accounts
db.getUser("appClient")

Example output:示例输出：

{
   _id: 'accounts.appClient',
   userId: UUID("1c2fc1bf-c4dc-4a22-8b04-3971349ce0dc"),
   user: 'appClient',
   db: 'accounts',
   roles: [],
   mechanisms: [ 'SCRAM-SHA-1', 'SCRAM-SHA-256' ]
}

db.getSiblingDB("products").runCommand( {
   createUser: "accountAdmin01",
   pwd: passwordPrompt(),
   customData: { employeeId: 12345 },
   roles: [ { role: 'readWrite', db: 'products' } ]
} )

db.getSiblingDB("products").getUser(
   "accountAdmin01",
   { showCustomData: false }
)

{
   _id: 'products.accountAdmin01',
   userId: UUID("0955afc1-303c-4683-a029-8e17dd5501f4"),
   user: 'accountAdmin01',
   db: 'products',
   roles: [ { role: 'readWrite', db: 'products' } ],
   mechanisms: [ 'SCRAM-SHA-1', 'SCRAM-SHA-256' ]
}