db.createRole()

定义

db.createRole(role, writeConcern)

在数据库中创建角色。您可通过显式列出特权、让角色从其他角色继承权限或同时执行二者为角色指定特权。此角色会应用于运行该方法的数据库。

重要

mongosh 方法

本页面提供 mongosh 方法的相关信息。这不是数据库命令或特定语言驱动程序（例如 Node.js）的相关文档。

有关数据库命令，请参阅 createRole 命令。

如需了解 MongoDB API 驱动程序，请参阅特定语言的 MongoDB 驱动程序文档。

db.createRole() 方法接受以下参数：

Parameter	类型	说明
role	文档	包含角色名称和角色定义的文档。
writeConcern	文档	可选。操作的写关注级别。请参阅写关注规范。

role 文档采用以下形式：

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

role 文档包含以下字段：

字段	类型	说明
role	字符串	新角色的名称。
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 操作。

例子

以下 db.createRole() 方法将对 admin 数据库创建 myClusterwideAdmin 角色：

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 }
)