db.updateRole()

定義

db.updateRole( rolename, update, writeConcern )

ユーザー定義のロール を更新します。db.updateRole() メソッドは、ロールのデータベースで実行する必要があります。

重要

mongosh メソッド

このページでは、mongosh メソッドについて記載しています。ただし、データベースコマンドや Node.js などの言語固有のドライバーのドキュメントには該当しません。

データベースコマンドについては、updateRole コマンドを参照してください。

MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。

フィールドを更新すると、前のフィールドの値が 完全に置き換えられます。 すべての値を置き換えずにロールまたは特権を付与または排除するには、次のメソッドの 1 つ以上を使用します。

• db.grantRolesToRole()

• db.grantPrivilegesToRole()

• db.revokeRolesFromRole()

• db.revokePrivilegesFromRole()

警告

privilegesまたはroles配列を更新すると、前の配列の値が 完全に置き換え られます。

db.updateRole()メソッドは次の構文を使用します。

db.updateRole(
    "<rolename>",
    {
      privileges:
          [
            { resource: { <resource> }, actions: [ "<action>", ... ] },
            ...
          ],
      roles:
          [
            { role: "<role>", db: "<database>" } | "<role>",
            ...
          ],
      authenticationRestrictions:
          [
            {
              clientSource: ["<IP>" | "<CIDR range>", ...],
              serverAddress: ["<IP>", | "<CIDR range>", ...]
            },
            ...
          ]
    },
    { <writeConcern> }
)

db.updateRole()メソッドは次の引数を受け入れます。

Parameter	タイプ	説明
rolename	string	更新するユーザー定義ロールの名前。
update	ドキュメント	ロールの置換データを含むドキュメント。 このデータは、ロールに対応するデータを完全に置き換えます。
writeConcern	ドキュメント	任意。 操作の 書込み保証（ write concern ） のレベル。 詳しくは、 書込み保証（write concern） の仕様を参照してください。

updateドキュメントでは、更新するフィールドと新しい値を指定します。 updateドキュメントの各フィールドは任意ですが、ドキュメントには少なくとも 1 つのフィールドを含める必要があります。 updateドキュメントには以下のフィールドがあります。

フィールド	タイプ	説明
privileges	配列	任意。 roles配列を指定しない場合は必須です。 ロールに付与する特権。 privileges配列を更新すると、前の配列の値は上書きされます。 特権を指定するための構文については、 privileges配列を参照してください。
roles	配列	任意。 privileges配列を指定しない場合は必須です。 このロールが特権を継承するロール。 roles配列を更新すると、前の配列の値は上書きされます。
authenticationRestrictions	配列	任意。 サーバーがロールに強制する認証制限。このロールを付与されたユーザーが接続できる、または接続元として使用できる IP アドレスと CIDR 範囲のリストを指定します。 バージョン 3.6 の新機能。

db.updateRole() メソッドは、updateRole コマンドをラップします。

互換性

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

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

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

"readWrite"

{ role: "<role>", db: "<database>" }

動作

必要なアクセス権

ロールを更新するには、すべてのデータベースに対してrevokeRoleアクションが必要です。

配列を更新するには、 roles配列内の各ロールのデータベースに対してgrantRoleアクションが必要です。

配列を更新するには、 privileges配列内の各特権のデータベースに対してgrantRoleアクションが必要です。 権限のリソースがデータベースにまたがる場合は、 adminデータベースにgrantRoleが必要です。 特権が次のいずれかである場合、特権はデータベースにまたがります。

• すべてのデータベースのコレクション

• すべてのコレクションとすべてのデータベース

• clusterリソース

ロールのauthenticationRestrictionsドキュメントを更新するには、ターゲット ロールのデータベースに対してsetAuthenticationRestrictionアクションが必要です。

例

次のdb.updateRole()メソッドは、 productsデータベースに存在するinventoryControlロールのprivilegesとrolesを置き換えます。 このメソッドは、 inventoryControlを含むデータベースで実行されます。

use products
db.updateRole(
    "inventoryControl",
    {
      privileges:
          [
            {
              resource: { db:"products", collection:"clothing" },
              actions: [ "update", "createCollection", "createIndex"]
            }
          ],
      roles:
          [
            {
              role: "read",
              db: "products"
            }
          ]
    },
    { w:"majority" }
)

ロールの特権を表示するには、 rolesInfoコマンドを使用します。