Skip to main content

GetRoles

List role definitions and their permissions.

Requires access_control.read permission. No input or output blobs are used.

Parameters​

  • roles (array of strings, optional): names to select; omitted selects all.

  • objects (boolean, optional): include object permissions; default true.

  • indexes (boolean, optional): include index permissions; default false.

  • access_control (boolean, optional): include user and role permissions; default false.

Behavior​

Unknown names are omitted. Each selected category contains boolean create, read, update, and delete permissions. Use GetUserDetails to see the combined permissions of a particular user.

Response​

Success returns status: 0, returned (the number of selected entries), and a roles object keyed by role name. Failures return a negative status and an info message; see Responses for error envelopes and retry guidance.

Examples​

[{
    "GetRoles": {
        "roles": ["researcher", "admin"],
        "objects": true,
        "indexes": true,
        "access_control": true
    }
}]

Response:

[{
    "GetRoles": {
        "status": 0,
        "returned": 2,
        "roles": {
            "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
                }
            },
            "admin": {
                "objects": {
                    "create": true,
                    "read": true,
                    "update": true,
                    "delete": true
                },
                "indexes": {
                    "create": true,
                    "read": true,
                    "update": true,
                    "delete": true
                },
                "access_control": {
                    "create": true,
                    "read": true,
                    "update": true,
                    "delete": true
                }
            }
        }
    }
}]