db.getUser()

項目一覧

定義

必要なアクセス権
例

定義

db.getUser(username, args)

指定されたユーザーのユーザー情報を返します。ユーザーのデータベースでこのメソッドを実行します。ユーザーがデータベースに存在しない場合、 db.getUser()はnullを返します。

db.getUser()メソッドには次のパラメータがあります。

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

Parameter	タイプ	説明
`username`	string	情報を検索するユーザーの名前。
`args`	ドキュメント	任意。追加の引数を指定するドキュメント。

args ドキュメントは、次のフィールドをサポートします。

フィールド	タイプ	説明
`showCredentials`	ブール値	任意。ユーザーのパスワードハッシュを表示するには、フィールドを true に設定します。 By default, this field is `false`.
`showPrivileges`	ブール値	任意。フィールドを true に設定すると、継承されたロールの展開情報を含む、ユーザーの完全な特権セットが表示されます。デフォルトでは、このフィールドは`false`です。すべてのユーザーを表示する場合は、このフィールドを指定できません。
`showAuthenticationRestrictions`	ブール値	任意。ユーザーの認証制限を表示するには、フィールドを true に設定します。デフォルトでは、このフィールドは`false`です。すべてのユーザーを表示する場合は、このフィールドを指定できません。
`filter`	ドキュメント	任意。フィルター条件に一致するユーザーの情報を返すために `$match` ステージ条件を指定するドキュメント。

db.getUser()はusersInfo: <username>コマンドをラップします。

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

必要なアクセス権

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

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

例

次の操作は、 accounts データベース内のサンプルappClient ユーザーに関する情報を返します。

use accounts
db.getUser("appClient")

出力例:

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

戻る

db.dropAllUsers

db.getUsers