.. _CreateRole: CreateRole ========== Create a role with permissions for objects, indexes, and user administration. Requires ``access_control.create`` 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 name must be new. Omitted permissions are false. Assign this role using CreateUser or UpdateUser. Creation does not change existing users. 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: CreateRole_1 .. code-block:: json [{ "CreateRole": { "name": "researcher", "objects": { "create": true, "read": true, "update": false, "delete": false }, "indexes": { "create": false, "read": false, "update": false, "delete": false }, "access_control": { "create": false, "read": false, "update": false, "delete": false } } }] Response: .. TESTED_EXAMPLE: CreateRole_1_response .. code-block:: json [{ "CreateRole": { "status": 0 } }] Example 2: .. TESTED_EXAMPLE: CreateRole_2 .. code-block:: json [{ "CreateRole": { "name": "architect", "objects": { "create": true, "read": true, "update": false, "delete": false }, "indexes": { "create": true, "read": true, "update": true, "delete": true }, "access_control": { "create": false, "read": true, "update": false, "delete": false } } }] Response: .. TESTED_EXAMPLE: CreateRole_2_response .. code-block:: json [{ "CreateRole": { "status": 0 } }]