Skip to main content

GetRoles

Retrieve roles' information.

Parameters​

  • [optional] roles: list of roles for which the information will be retrieved. By default, all roles will be retrieved.
  • [optional] objects: indicates if permissions for objects will be retrieved.
  • [optional] indexes: indicates if permissions for indexes will be retrieved.
  • [optional] access_control: indicates if permissions for access_control will be retrieved.

Details​

By default, all permissions for all roles will be retrieved.

Examples​

Retrieve all roles' information for roles "researcher" and "admin", using GetRoles command:


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

Result from a system with both roles:


    [{
        "GetRoles": {
            "status": 0,
            "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
                }
            }
        }
    }]