db.getUsers()（mongoshメソッド）

定義

db.getUsers(<options>)

データベース内のすべてのユーザーの情報を返します。

db.getUsers() wraps the usersInfo: 1 command.

The db.getUsers() method can take the following options:

db.getUsers( {
   showCredentials: <Boolean>,
   showCustomData: <Boolean>,
   authenticatedMechanism: <string>,
   filter: <document>
} )

フィールド	タイプ	説明
showCredentials	ブール値	任意。 ユーザーのパスワード ハッシュを表示するには、 をtrueに設定します。 デフォルトでは、このフィールドは false です。
showCustomData	ブール値	任意。 Set to false to omit the user's customData from the output. デフォルトでは、このフィールドは true です。 バージョン5.2の新機能。
authenticatedMechanism	string	バージョン9.0の新機能。 任意。サポートされている認証メカニズムを表すstringに設定し、db.getUsers()がユーザーの承認情報をどこで検索するかを決定します。メカニズムとその関連stringのリストについては、authenticationMechanismsを参照してください。 このフィールドが指定されていない場合、db.getUsers()は、$externalデータベースで定義されたユーザーについてはLDAPから、SCRAMユーザーについてはローカル承認データベースから情報を返します。
filter	ドキュメント	任意。 フィルター条件に一致するユーザーの情報を返すために$matchステージ条件を指定するドキュメント。

詳細については、usersInfo を参照してください。

互換性

このメソッドは、次の環境でホストされている配置で使用できます。

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

必要なアクセス権

他のユーザーの情報を表示するには、他のユーザーのデータベースに対してviewUserアクションが必要です。

ユーザーは自分の情報を表示できます。

例

db.getUsers({ filter: { mechanisms: "SCRAM-SHA-256" } })

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

db.getSiblingDB("products").getUsers( { showCustomData: false } )

{
   users: [
     {
       _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' ]
     }
   ],
   ok: 1
}