.. _UpdateRole: UpdateRole ========== Change a role with permissions for objects, indexes, and user administration. Requires ``access_control.update`` permission. No input or output blobs are used. Parameters ---------- * ``name`` (string, required): role name. * ``objects``, ``indexes``, ``access_control`` (objects, optional): each accepts boolean ``create``, ``read``, ``update``, and ``delete`` fields. Behavior -------- The role must exist. Supplied fields replace those permissions; omitted fields remain unchanged. Every user assigned the role has their sessions revoked in the same transaction and must authenticate again. Other roles may still grant permissions removed here. Role changes commit or roll back with the query. See :doc:`../AccessControl`. Response -------- Success returns ``status: 0``. Failures return a negative ``status`` and an ``info`` message; see :doc:`../Responses` for error envelopes and retry guidance. Examples -------- Example 1: .. TESTED_EXAMPLE: UpdateRole_1 .. code-block:: json [{ "UpdateRole": { "name": "researcher", "objects": { "update": true, "delete": true }, "indexes": { "create": true } } }] Response: .. TESTED_EXAMPLE: UpdateRole_1_response .. code-block:: json [{ "UpdateRole": { "status": 0 } }] Example 2: .. TESTED_EXAMPLE: UpdateRole_2 .. code-block:: json [{ "UpdateRole": { "name": "architect", "objects": { "create": false }, "access_control": { "read": false } } }] Response: .. TESTED_EXAMPLE: UpdateRole_2_response .. code-block:: json [{ "UpdateRole": { "status": 0 } }]