db.revokeRolesFromRole.txt

========================
db.revokeRolesFromRole()
========================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. method:: db.revokeRolesFromRole ( rolename, roles, writeConcern )

   Removes the specified inherited roles from a role.

   The :method:`revokeRolesFromRole` method uses the following syntax:

   .. code-block:: javascript

      db.revokeRolesFromRole( "<rolename>", [ <roles> ], { <writeConcern> } )

   The :method:`revokeRolesFromRole` method takes the following arguments:


   .. list-table::
      :header-rows: 1
      :widths: 20 20 80
   
      * - Parameter
   
        - Type
   
        - Description
   
      * - ``rolename``
   
        - string
   
        - The name of the role from which to revoke roles.
          
          
   
      * - ``roles``
   
        - array
   
        - The inherited roles to remove.
          
          
   
      * - ``writeConcern``
   
        - document
   
        - Optional. The level of :doc:`write concern </reference/write-concern>` to apply
          to this operation. The ``writeConcern`` document uses the same fields
          as the :dbcommand:`getLastError` command.
          
          
   


   .. |local-cmd-name| replace:: :method:`db.revokeRolesFromRole()`
   .. include:: /includes/fact-roles-array-contents.rst

   The :method:`db.revokeRolesFromRole()` method wraps the
   :dbcommand:`revokeRolesFromRole` command.

Required Access
---------------

.. include:: /includes/access-revoke-roles.rst

Example
-------

The ``purchaseAgents`` role in the ``emea`` database inherits privileges
from several other roles, as listed in the ``roles`` array:

.. code-block:: javascript

   {
      "_id" : "emea.purchaseAgents",
      "role" : "purchaseAgents",
      "db" : "emea",
      "privileges" : [],
      "roles" : [
         {
            "role" : "readOrdersCollection",
            "db" : "emea"
         },
         {
            "role" : "readAccountsCollection",
            "db" : "emea"
         },
         {
            "role" : "writeOrdersCollection",
            "db" : "emea"
         }
      ]
   }

The following :method:`db.revokeRolesFromRole()` operation on the ``emea``
database removes two roles from the ``purchaseAgents`` role:

.. code-block:: javascript

   use emea
   db.revokeRolesFromRole( "purchaseAgents",
                           [
                             "writeOrdersCollection",
                             "readOrdersCollection"
                           ],
                           { w: "majority" , wtimeout: 5000 }
                         )

The ``purchaseAgents`` role now contains just one role:

.. code-block:: javascript

   {
      "_id" : "emea.purchaseAgents",
      "role" : "purchaseAgents",
      "db" : "emea",
      "privileges" : [],
      "roles" : [
         {
            "role" : "readAccountsCollection",
            "db" : "emea"
         }
      ]
   }