/
db.revokePrivilegesFromRole.txt
192 lines (143 loc) · 4.14 KB
/
db.revokePrivilegesFromRole.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
=============================
db.revokePrivilegesFromRole()
=============================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. method:: db.revokePrivilegesFromRole ( rolename, privileges, writeConcern )
Removes the specified privileges from the :ref:`user-defined
<user-defined-roles>` role on the database where the method runs. The
:method:`revokePrivilegesFromRole` method has the following syntax:
.. code-block:: javascript
db.revokePrivilegesFromRole(
"<rolename>",
[
{ resource: { <resource> }, actions: [ "<action>", ... ] },
...
],
{ <writeConcern> }
)
The :method:`revokePrivilegesFromRole` method takes the following arguments:
.. list-table::
:header-rows: 1
:widths: 20 20 80
* - Parameter
- Type
- Description
* - ``rolename``
- string
- The name of the :ref:`user-defined <user-defined-roles>` role from
which to revoke privileges.
* - ``privileges``
- array
- An array of privileges to remove from the role. See
:data:`~admin.system.roles.privileges` for more information on the
format of the privileges.
* - ``writeConcern``
- document
- Optional. The level of :doc:`write concern </reference/write-concern>` for the
modification. The ``writeConcern`` document takes the same
fields as the :dbcommand:`getLastError` command.
The :method:`db.revokePrivilegesFromRole()` method wraps the
:dbcommand:`revokePrivilegesFromRole` command.
Behavior
--------
To revoke a privilege, the :doc:`resource document
</reference/resource-document>` pattern must match **exactly** the
``resource`` field of that privilege. The ``actions`` field can be a
subset or match exactly.
For example, given the role ``accountRole`` in the ``products``
database with the following privilege that specifies the ``products``
database as the resource:
.. code-block:: javascript
{
"resource" : {
"db" : "products",
"collection" : ""
},
"actions" : [
"find",
"update"
]
}
You *cannot* revoke ``find`` and/or ``update`` from just *one*
collection in the ``products`` database. The following operations
result in no change to the role:
.. code-block:: javascript
use products
db.revokePrivilegesFromRole(
"accountRole",
[
{
resource : {
db : "products",
collection : "gadgets"
},
actions : [
"find",
"update"
]
}
]
)
db.revokePrivilegesFromRole(
"accountRole",
[
{
resource : {
db : "products",
collection : "gadgets"
},
actions : [
"find"
]
}
]
)
To revoke the ``"find"`` and/or the ``"update"`` action from the role
``accountRole``, you must match the resource document exactly. For
example, the following operation revokes just the ``"find"`` action
from the existing privilege.
.. code-block:: javascript
use products
db.revokePrivilegesFromRole(
"accountRole",
[
{
resource : {
db : "products",
collection : ""
},
actions : [
"find"
]
}
]
)
Required Access
---------------
.. include:: /includes/access-revoke-privileges.rst
Example
-------
The following operation removes multiple privileges from the
``associates`` role:
.. code-block:: javascript
db.revokePrivilegesFromRole(
"associate",
[
{
resource: { db: "products", collection: "" },
actions: [ "createCollection", "createIndex", "find" ]
},
{
resource: { db: "products", collection: "orders" },
actions: [ "insert" ]
}
],
{ w: "majority" }
)