db.createRole()

定義

db.createRole(role, writeConcern)

Creates a role in a database. You can specify privileges for the role by explicitly listing the privileges or by having the role inherit privileges from other roles or both. The role applies to the database on which you run the method.

重要

mongosh メソッド

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

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

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

The db.createRole() method accepts the following arguments:

Parameter	タイプ	説明
role	ドキュメント	A document containing the name of the role and the role definition.
writeConcern	ドキュメント	任意。 操作の 書込み保証（ write concern ） のレベル。 詳しくは、 書込み保証（write concern） の仕様を参照してください。

The role document has the following form:

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

roleドキュメントには、以下のフィールドがあります。

フィールド	タイプ	説明
role	string	新しいロールの名前。
privileges	配列	ロールに付与する特権。特権は、リソースと許可されたアクションから構成されます。権限の構文については、privileges 配列を参照してください。 privileges フィールドを含める必要があります。特権を指定しない場合は、空の配列を使用します。
roles	配列	このロールが特権を継承するロールの配列。 roles フィールドを含める必要があります。継承するロールを指定しない場合は、空の配列を使用します。
authenticationRestrictions	配列	任意。 サーバーがロールに強制する認証制限。このロールを付与されたユーザーが接続できる、または接続元として使用できる IP アドレスと CIDR 範囲のリストを指定します。

"readWrite"

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

互換性

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

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

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

動作

必要なアクセス権

データベースにロールを作成するには、以下が必要です。

• そのデータベース リソース上のcreateRole アクション。

• 新しいロールの権限を指定し、継承するロールを指定する、そのデータベース上のgrantRole アクション。

組み込みロール userAdmin と userAdminAnyDatabase は、それぞれのリソース上で createRole および grantRole のアクションを提供します。

authenticationRestrictions　を指定してロールを作成するには、ロールが作成されるデータベース リソース上のsetAuthenticationRestriction アクションが必要です。

例

The following db.createRole() method creates the myClusterwideAdmin role on the admin database:

use admin
db.createRole(
   {
     role: "myClusterwideAdmin",
     privileges: [
       { resource: { cluster: true }, actions: [ "addShard" ] },
       { resource: { db: "config", collection: "" }, actions: [ "find", "update", "insert", "remove" ] },
       { resource: { db: "users", collection: "usersCollection" }, actions: [ "update", "insert", "remove" ] },
       { resource: { db: "", collection: "" }, actions: [ "find" ] }
     ],
     roles: [
       { role: "read", db: "admin" }
     ]
   },
   { w: "majority" , wtimeout: 5000 }
)