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 Access Control.

Response

Success returns status: 0. Failures return a negative status and an info message; see Responses for error envelopes and retry guidance.

Examples

Example 1:

[{
    "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:

[{
    "CreateRole": {
        "status": 0
    }
}]

Example 2:

[{
    "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:

[{
    "CreateRole": {
        "status": 0
    }
}]