updateRole

定義

updateRole

Updates a user-defined role. The updateRole command must run on the role's database.

Tip

mongoshでは、このコマンドはdb.updateRole()ヘルパー メソッドを通じて実行することもできます。

ヘルパー メソッドはmongoshユーザーには便利ですが、データベースコマンドと同じレベルの情報は返されない可能性があります。 便宜上必要ない場合、または追加の戻りフィールドが必要な場合は、 データベースコマンドを使用します。

An update to a field completely replaces the previous field's values. To grant or remove roles or privileges without replacing all values, use one or more of the following commands:

• grantRolesToRole

• grantPrivilegesToRole

• revokeRolesFromRole

• revokePrivilegesFromRole

警告

An update to the privileges or roles array completely replaces the previous array's values.

互換性

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

• MongoDB Atlas はクラウドでの MongoDB 配置のためのフルマネージド サービスです

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

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

構文

To update a role, you must provide the privileges array, roles array, or both.

コマンドは、次の構文を使用します。

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

コマンドフィールド

このコマンドは、次のフィールドを使用します。

"readWrite"

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

動作

A role's privileges apply to the database where the role is created. The role can inherit privileges from other roles in its database. A role created on the admin database can include privileges that apply to all databases or to the クラスター and can inherit privileges from roles in other databases.

必要なアクセス権

You must have the revokeRole アクション on all databases in order to update a role.

You must have the grantRole アクション on the database of each role in the roles array to update the array.

You must have the grantRole アクション on the database of each privilege in the privileges array to update the array. If a privilege's resource spans databases, you must have grantRole on the admin database. A privilege spans databases if the privilege is any of the following:

• a collection in all databases

• all collections and all database

• the cluster resource

You must have the setAuthenticationRestriction アクション on the database of the target role to update a role's authenticationRestrictions document.

例

The following is an example of the updateRole command that updates the myClusterwideAdmin role on the admin database. While the privileges and the roles arrays are both optional, at least one of the two is required:

db.adminCommand(
   {
     updateRole: "myClusterwideAdmin",
     privileges:
         [
           {
             resource: { db: "", collection: "" },
             actions: [ "find" , "update", "insert", "remove" ]
           }
         ],
     roles:
         [
           { role: "dbAdminAnyDatabase", db: "admin" }
         ],
     writeConcern: { w: "majority" }
   }
)

To view a role's privileges, use the rolesInfo command.