定義
db.getUsers(<options>)データベース内のすべてのユーザーの情報を返します。
db.getUsers()はusersInfo: 1コマンドをラップします。db.getUsers()メソッドは次のオプションを取ることができます。db.getUsers( { showCredentials: <Boolean>, filter: <document> } ) フィールドタイプ説明showCredentialsブール値
任意。 ユーザーのパスワード ハッシュを表示するには、 フィールドを true に設定します。 By default, this field is
false.filterドキュメント
任意。 フィルター条件に一致するユーザーの情報を返すために
$matchステージ条件を指定するドキュメント。詳細については、
usersInfoを参照してください。
互換性
このメソッドは、次の環境でホストされている配置で使用できます。
重要
このコマンドは、 MongoDB Atlasクラスターではサポートされていません。 すべてのコマンドの Atlas サポートの詳細については、「 サポートされていないコマンド 」を参照してください。
MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン
必要なアクセス権
他のユーザーの情報を表示するには、他のユーザーのデータベースに対してviewUserアクションが必要です。
ユーザーは自分の情報を表示できます。
例
指定したフィルターに一致するデータベースのすべてのユーザーの表示
db.getUsers()メソッドはfilterドキュメントを受け入れて、フィルター条件に一致するユーザーの情報を返すことができます。
現在のデータベースでSCRAM-SHA-256資格情報を持つすべてのユーザーを表示するには、
db.getUsers({ filter: { mechanisms: "SCRAM-SHA-256" } })
すべてのユーザーを表示する場合は、 showCredentialsオプションを指定できますが、 showPrivilegesまたはshowAuthenticationRestrictionsオプションは指定できません。